diff --git a/docs/7.0.X/allclasses-index.html b/docs/7.0.X/allclasses-index.html new file mode 100644 index 000000000..3950be69d --- /dev/null +++ b/docs/7.0.X/allclasses-index.html @@ -0,0 +1,946 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>All Classes and Interfaces (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="class index"> +<meta name="generator" content="javadoc/AllClassesIndexWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="all-classes-index-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-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#all-classes">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1> +</div> +<div id="all-classes-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button><button id="all-classes-table-tab7" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab7', 2)" class="table-tab">Annotation Interfaces</button></div> +<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a><<a href="org/apache/datasketches/tuple/AnotB.html" title="type parameter in AnotB">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods of serializing and deserializing arrays of Boolean as a bit array.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Computes a set difference of two tuple sketches of type ArrayOfDoubles</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two ArrayOfDoublesSketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">Combines two arrays of double values for use with ArrayOfDoubles tuple sketches</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Top level compact tuple sketch of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Computes the intersection of two or more tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods of serializing and deserializing arrays of Double.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Builds set operations object for tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values + is associated with each key.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Convenient static methods to instantiate tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">Interface for iterating over tuple sketches of type ArrayOfDoubles</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The base class for unions of tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">For building a new ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Base class for serializing and deserializing custom types.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods of serializing and deserializing arrays of Long.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods of serializing and deserializing arrays of the object version of primitive types of + Number.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Contains common equality binary search algorithms.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tdigest/BinarySearch.html" title="class in org.apache.datasketches.tdigest">BinarySearch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Algorithms with logarithmic complexity for searching in an array.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/thetacommon/BinomialBoundsN.html" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class enables the estimation of error bounds given a sample set size, the sampling + probability theta, the number of standard deviations and a simple noDataSeen flag.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/BitPacking.html" title="class in org.apache.datasketches.theta">BitPacking</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Used as part of Theta compression.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A Bloom filter is a data structure that can be used for probabilistic + set membership.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class provides methods to help estimate the correct parameters when + creating a Bloom filter, and methods to create the filter using those values.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Confidence intervals for binomial proportions.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>|B| / |A|</i>, where: + + <i>|A|</i> is the unknown size of a set <i>A</i> of unique identifiers. + <i>|B|</i> is the unknown size of a subset <i>B</i> of <i>A</i>. + <i>a</i> = <i>|S<sub>A</sub>|</i> is the observed size of a sample of <i>A</i> + that was obtained by Bernoulli sampling with a known inclusion probability <i>f</i>. + <i>b</i> = <i>|S<sub>A</sub> ∩ B|</i> is the observed size of a subset + of <i>S<sub>A</sub></i>. + </div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + + <i>A</i> is a Theta Sketch of population <i>PopA</i>. + <i>B</i> is a Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Theta Sketch <i>C</i>, + which acts like a predicate or selection clause. + The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). + The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). + The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). + + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + + <i>A</i> is a Tuple Sketch of population <i>PopA</i>. + <i>B</i> is a Tuple or Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Tuple or Theta Sketch <i>C</i>, + which acts like a predicate or selection clause. + The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). + The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). + The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). + + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">This instructs the user about which of the upper and lower bounds of a partition definition row + should be included with the returned data.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Useful methods for byte arrays.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/ClassicUtil.html" title="class in org.apache.datasketches.quantiles">ClassicUtil</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Utilities for the classic quantiles sketches and independent of the type.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The parent class of all the CompactSketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="org/apache/datasketches/tuple/CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">CompactSketches are never created directly.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/CompressionCharacterization.html" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This is a unique-counting sketch that implements the + <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in + his paper + <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly + Optimal Cardinality Estimation Algorithm</a>.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The union (merge) operation for the CPC sketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This provides a read-only view of a serialized image of a CpcSketch, which can be + on-heap or off-heap represented as a Memory object, or on-heap represented as a byte array.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="org/apache/datasketches/tuple/DeserializeResult.html" title="type parameter in DeserializeResult">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class can maintain the BitArray object off-heap.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">For building a new quantiles DoublesSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over DoublesSketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Sorted View for quantile sketches of primitive type double.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over quantile sketches of primitive type <i>double</i>.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Summary for generic tuple sketches of type Double.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">The aggregation modes for this Summary</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Factory for DoubleSummary.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods for defining how unions and intersections of two objects of type DoubleSummary + are performed.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The API for Union operations for quantiles DoublesSketches</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">For building a new DoublesSketch Union operation.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">An implementation of an Exact and Bounded Sampling Proportional to Size sketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/frequencies/ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">Specifies one of two types of error regions of the statistical classification Confusion Matrix + that can be excluded from a returned sample of Frequent Items.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">Defines the various families of sketch and set operation classes.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A Frequent Distinct Tuples sketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/Filter.html" title="class in org.apache.datasketches.tuple">Filter</a><<a href="org/apache/datasketches/tuple/Filter.html" title="type parameter in Filter">T</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Class for filtering entries from a <a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Sorted View for quantiles of primitive type float.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over quantile sketches of primitive type <i>float</i>.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.html" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">The enumerator of inequalities</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="type parameter in GenericSortedView">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Sorted View for quantiles of generic type.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over quantile sketches of generic type.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Defines a Group from a Frequent Distinct Tuple query.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/theta/HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This is used to iterate over the retained hash values of the Theta sketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Helper class for the common hash table methods.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The HllSketch is actually a collection of compact implementations of Phillipe Flajolet’s HyperLogLog (HLL) + sketch but with significantly improved error behavior and excellent speed performance.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class reinserts the min and max values into the sorted view arrays as required.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" title="type parameter in IncludeMinMax.ItemsPair">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Summary for generic tuple sketches of type Integer.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">The aggregation modes for this Summary</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Factory for IntegerSummary.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary + are performed.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The API for intersection operations</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a><<a href="org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches + combined with theta sketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This sketch is useful for tracking approximate frequencies of items of type <i><T></i> + with optional associated counts (<i><T></i> item, <i>long</i> count) that are members of a + multiset of such items.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><<a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="type parameter in ItemsSketchIterator">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over ItemsSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The API for Union operations for generic ItemsSketches</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Jaccard similarity of two Theta Sketches.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Jaccard similarity of two Tuple Sketches, or alternatively, of a Tuple and Theta Sketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over KllDoublesSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over KllFloatsSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllItemsSketchIterator.html" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><<a href="org/apache/datasketches/kll/KllItemsSketchIterator.html" title="type parameter in KllItemsSketchIterator">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over KllItemsSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllLongsSketchIterator.html" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over KllLongsSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class is the root of the KLL sketch class hierarchy.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">Used primarily to define the structure of the serialized sketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">Used to define the variable type of the current instance of this class.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/kll/KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The base implementation for the KLL sketch iterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Kolmogorov-Smirnov Test + See <a href="https://en.wikipedia.org/wiki/Kolmogorov-Smirnov_test">Kolmogorov–Smirnov Test</a></div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional + associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of + such items.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The SortedView of the KllLongsSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Sorted View for quantile sketches of primitive type long.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over quantile sketches of primitive type <i>long</i>.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">Methods for inquiring the status of a backing Memory object.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/MergingValidation.html" title="class in org.apache.datasketches.cpc">MergingValidation</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The MurmurHash3 is a fast, non-cryptographic, 128-bit hash function that has + excellent avalanche and 2-way bit independence properties.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A general purpose wrapper for the MurmurHash3.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/partitions/Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a><<a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">S</a> extends <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">T</a>> & <a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">T</a>>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A partitioning process that can partition very large data sets into thousands + of partitions of approximately the same size.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Defines a row for List of PartitionBounds.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><<a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Holds data for a Stack element</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This processes the contents of a FDT sketch to extract the + primary keys with the most frequent unique combinations of the non-primary dimensions.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" title="type parameter in QuantilesGenericSketchIterator">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The quantiles sketch iterator for generic types.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The Quantiles API for item type <i>long</i>.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The quantiles sketch iterator for primitive type long.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Utilities for the quantiles sketches.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/QuickMergingValidation.html" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/thetacommon/QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">QuickSelect algorithm improved from Sedgewick.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">The signaling interface that allows comprehensive analysis of the ReqSketch and ReqCompactor + while eliminating code clutter in the main classes.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper + "Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty, + Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">For building a new ReqSketch</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/req/ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over all retained items of the ReqSketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This sketch provides a reservoir sample over an input stream of items.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Class to union reservoir samples of generic items.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This sketch provides a reservoir sample over an input stream of <code>long</code>s.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Class to union reservoir samples of longs.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">A simple object o capture the results of a subset sum query on a sampling sketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Multipurpose serializer-deserializer for a collection of sketches defined by the enum.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The parent API for all Set Operations</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">For building a new SetOperation.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Simplifies and speeds up set operations by resolving specific corner cases.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">A not B actions</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">List of corner cases</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block">Intersection actions</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">List of union actions</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The top-level class for all theta sketches.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="org/apache/datasketches/tuple/Sketch.html" title="type parameter in Sketch">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class brings together the common sketch and set operation creation methods and + the public static methods into one place.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Convenient static methods to instantiate generic tuple sketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="org/apache/datasketches/common/SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab5"> +<div class="block">Illegal Arguments Exception class for the library</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="org/apache/datasketches/common/SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> +<div class="block">Exception class for the library</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="org/apache/datasketches/common/SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab5"> +<div class="block">Write operation attempted on a read-only class.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="org/apache/datasketches/common/SketchesStateException.html" title="class in org.apache.datasketches.common">SketchesStateException</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> +<div class="block">Illegal State Exception class for the library</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a>,<wbr><a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">S</a> extends <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a>> & <a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a>>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This is a callback request to the data source to fill a quantiles sketch, + which is returned to the caller.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This defines the methods required to compute the partition limits.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tdigest/Sort.html" title="class in org.apache.datasketches.tdigest">Sort</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Specialized sorting algorithm that can sort one array and permute another array the same way.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This is the base interface for the Sorted View interface hierarchy and defines the methods that are type independent.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This is the base interface for the SortedViewIterator hierarchy used with a SortedView obtained + from a quantile-type sketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/StreamingValidation.html" title="class in org.apache.datasketches.cpc">StreamingValidation</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="type parameter in SummaryDeserializer">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">Interface for deserializing user-defined Summary</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="org/apache/datasketches/tuple/SummaryFactory.html" title="type parameter in SummaryFactory">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">Interface for user-defined SummaryFactory</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab7"><a href="org/apache/datasketches/common/SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab7"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/cpc/TestUtil.html" title="class in org.apache.datasketches.cpc">TestUtil</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> +<div class="block">Specifies the target type of HLL sketch to be created.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Utility methods for the Theta Family of sketches</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="org/apache/datasketches/tuple/TupleSketchIterator.html" title="type parameter in TupleSketchIterator">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Iterator over a generic tuple sketch</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This performs union operations for all HllSketches.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Compute the union of two or more theta sketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a><<a href="org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with + theta sketches.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This is a real-time, key-value HLL mapping sketch that tracks approximate unique counts of + identifiers (the values) associated with each key.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a> extends <a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a> extends <a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">For building a new generic tuple UpdatableSketch</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> +<div class="block">Interface for updating user-defined Summary</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> +<div class="block"><a href="./resources/dictionary.html#updateReturnState">See Update Return State</a></div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">For building a new UpdateSketch.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Common utility functions.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Common utility functions for Tuples</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This class provides access to the samples contained in a VarOptItemsSketch.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">This sketch provides a variance optimal sample over an input stream of weighted items.</div> +</div> +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>></div> +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> +<div class="block">Provides a unioning operation over varopt sketches.</div> +</div> +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/apache/datasketches/hash/XxHash.html" title="class in org.apache.datasketches.hash">XxHash</a></div> +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> +<div class="block">The XxHash is a fast, non-cryptographic, 64-bit hash function that has + excellent avalanche and 2-way bit independence properties.</div> +</div> +</div> +</div> +</div> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/allpackages-index.html b/docs/7.0.X/allpackages-index.html new file mode 100644 index 000000000..909af2643 --- /dev/null +++ b/docs/7.0.X/allpackages-index.html @@ -0,0 +1,173 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>All Packages (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="package index"> +<meta name="generator" content="javadoc/AllPackagesIndexWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="all-packages-index-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-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#all-packages">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="All&nbsp;Packages" class="title">All Packages</h1> +</div> +<div class="caption"><span>Package Summary</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></div> +<div class="col-last even-row-color"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a></div> +<div class="col-last odd-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/filters/package-summary.html">org.apache.datasketches.filters</a></div> +<div class="col-last even-row-color"> +<div class="block">The filters package contains data structures used to determine + approximate set-membership.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/filters/bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a></div> +<div class="col-last odd-row-color"> +<div class="block">BloomFilter package</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a></div> +<div class="col-last odd-row-color"> +<div class="block">The hash package contains a high-performing and extended Java implementations + of Austin Appleby's 128-bit MurmurHash3 hash function originally coded in C.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/hll/package-summary.html">org.apache.datasketches.hll</a></div> +<div class="col-last even-row-color"> +<div class="block">The DataSketches™ HLL sketch family package</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/hllmap/package-summary.html">org.apache.datasketches.hllmap</a></div> +<div class="col-last odd-row-color"> +<div class="block">The hllmap package contains a space efficient HLL mapping sketch of keys to approximate unique + count of identifiers.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/tdigest/package-summary.html">org.apache.datasketches.tdigest</a></div> +<div class="col-last even-row-color"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></div> +<div class="col-last odd-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="./resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first even-row-color"><a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +<div class="col-first odd-row-color"><a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/constant-values.html b/docs/7.0.X/constant-values.html new file mode 100644 index 000000000..2bc9fe362 --- /dev/null +++ b/docs/7.0.X/constant-values.html @@ -0,0 +1,245 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Constant Field Values (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="summary of constants"> +<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="constants-summary-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-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#constant-values">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Constant Field Values" class="title">Constant Field Values</h1> +<section class="packages"> +<h2 title="Contents">Contents</h2> +<ul> +<li><a href="#org.apache">org.apache.*</a></li> +</ul> +</section> +</div> +<section class="constants-summary" id="org.apache.datasketches.common"> +<h2 title="org.apache">org.apache.*</h2> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.common.Util.INVERSE_GOLDEN">public static final double</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/common/Util.html#INVERSE_GOLDEN">INVERSE_GOLDEN</a></code></div> +<div class="col-last even-row-color"><code>0.6180339887498949</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.common.Util.INVERSE_GOLDEN_U64">public static final long</code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/common/Util.html#INVERSE_GOLDEN_U64">INVERSE_GOLDEN_U64</a></code></div> +<div class="col-last odd-row-color"><code>-7046029254386353133L</code></div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.common.Util.LONG_MAX_VALUE_AS_DOUBLE">public static final double</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/common/Util.html#LONG_MAX_VALUE_AS_DOUBLE">LONG_MAX_VALUE_AS_DOUBLE</a></code></div> +<div class="col-last even-row-color"><code>9.223372036854776E18</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.common.Util.TAB">public static final char</code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/common/Util.html#TAB">TAB</a></code></div> +<div class="col-last odd-row-color"><code>'\t'</code></div> +</div> +</li> +</ul> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.cpc.CpcSketch.DEFAULT_LG_K">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/cpc/CpcSketch.html#DEFAULT_LG_K">DEFAULT_LG_K</a></code></div> +<div class="col-last even-row-color"><code>11</code></div> +</div> +</li> +</ul> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.hll.HllSketch.DEFAULT_LG_K">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/hll/HllSketch.html#DEFAULT_LG_K">DEFAULT_LG_K</a></code></div> +<div class="col-last even-row-color"><code>12</code></div> +</div> +</li> +</ul> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.kll.KllSketch.DEFAULT_K">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/kll/KllSketch.html#DEFAULT_K">DEFAULT_K</a></code></div> +<div class="col-last even-row-color"><code>200</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.kll.KllSketch.MAX_K">public static final int</code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/kll/KllSketch.html#MAX_K">MAX_K</a></code></div> +<div class="col-last odd-row-color"><code>65535</code></div> +</div> +</li> +</ul> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.quantilescommon.QuantilesAPI.EMPTY_MSG">public static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a></code></div> +<div class="col-last even-row-color"><code>"The sketch must not be empty for this operation. "</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.quantilescommon.QuantilesAPI.MEM_REQ_SVR_NULL_MSG">public static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a></code></div> +<div class="col-last odd-row-color"><code>"MemoryRequestServer must not be null. "</code></div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.quantilescommon.QuantilesAPI.NOT_SINGLE_ITEM_MSG">public static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a></code></div> +<div class="col-last even-row-color"><code>"Sketch does not have just one item. "</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.quantilescommon.QuantilesAPI.SELF_MERGE_MSG">public static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a></code></div> +<div class="col-last odd-row-color"><code>"A sketch cannot merge with itself. "</code></div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.quantilescommon.QuantilesAPI.TGT_IS_READ_ONLY_MSG">public static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a></code></div> +<div class="col-last even-row-color"><code>"Target sketch is Read Only, cannot write. "</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.quantilescommon.QuantilesAPI.UNSUPPORTED_MSG">public static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +<div class="col-last odd-row-color"><code>"Unsupported operation for this Sketch Type. "</code></div> +</div> +</li> +<li> +<div class="caption"><span>org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.quantilescommon.QuantilesUtil.tailRoundingFactor">public static final double</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#tailRoundingFactor">tailRoundingFactor</a></code></div> +<div class="col-last even-row-color"><code>1.0E7</code></div> +</div> +</li> +</ul> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.tdigest.TDigestDouble.DEFAULT_K">public static final short</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/tdigest/TDigestDouble.html#DEFAULT_K">DEFAULT_K</a></code></div> +<div class="col-last even-row-color"><code>200</code></div> +</div> +</li> +</ul> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.thetacommon.HashOperations.STRIDE_MASK">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/thetacommon/HashOperations.html#STRIDE_MASK">STRIDE_MASK</a></code></div> +<div class="col-last even-row-color"><code>127</code></div> +</div> +</li> +<li> +<div class="caption"><span>org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.thetacommon.ThetaUtil.DEFAULT_NOMINAL_ENTRIES">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#DEFAULT_NOMINAL_ENTRIES">DEFAULT_NOMINAL_ENTRIES</a></code></div> +<div class="col-last even-row-color"><code>4096</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.thetacommon.ThetaUtil.DEFAULT_UPDATE_SEED">public static final long</code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#DEFAULT_UPDATE_SEED">DEFAULT_UPDATE_SEED</a></code></div> +<div class="col-last odd-row-color"><code>9001L</code></div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.thetacommon.ThetaUtil.MAX_LG_NOM_LONGS">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#MAX_LG_NOM_LONGS">MAX_LG_NOM_LONGS</a></code></div> +<div class="col-last even-row-color"><code>26</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.thetacommon.ThetaUtil.MIN_LG_ARR_LONGS">public static final int</code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#MIN_LG_ARR_LONGS">MIN_LG_ARR_LONGS</a></code></div> +<div class="col-last odd-row-color"><code>5</code></div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.thetacommon.ThetaUtil.MIN_LG_NOM_LONGS">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#MIN_LG_NOM_LONGS">MIN_LG_NOM_LONGS</a></code></div> +<div class="col-last even-row-color"><code>4</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.thetacommon.ThetaUtil.REBUILD_THRESHOLD">public static final double</code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#REBUILD_THRESHOLD">REBUILD_THRESHOLD</a></code></div> +<div class="col-last odd-row-color"><code>0.9375</code></div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.thetacommon.ThetaUtil.RESIZE_THRESHOLD">public static final double</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#RESIZE_THRESHOLD">RESIZE_THRESHOLD</a></code></div> +<div class="col-last even-row-color"><code>0.5</code></div> +</div> +</li> +</ul> +<ul class="block-list"> +<li> +<div class="caption"><span>org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Constant Field</div> +<div class="table-header col-last">Value</div> +<div class="col-first even-row-color"><code id="org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder.DEFAULT_NOMINAL_ENTRIES">public static final int</code></div> +<div class="col-second even-row-color"><code><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#DEFAULT_NOMINAL_ENTRIES">DEFAULT_NOMINAL_ENTRIES</a></code></div> +<div class="col-last even-row-color"><code>4096</code></div> +<div class="col-first odd-row-color"><code id="org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder.DEFAULT_NUMBER_OF_VALUES">public static final int</code></div> +<div class="col-second odd-row-color"><code><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#DEFAULT_NUMBER_OF_VALUES">DEFAULT_NUMBER_OF_VALUES</a></code></div> +<div class="col-last odd-row-color"><code>1</code></div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/deprecated-list.html b/docs/7.0.X/deprecated-list.html new file mode 100644 index 000000000..fba8eacb5 --- /dev/null +++ b/docs/7.0.X/deprecated-list.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Deprecated List (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="deprecated elements"> +<meta name="generator" content="javadoc/DeprecatedListWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="deprecated-list-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li class="nav-bar-cell1-rev">Deprecated</li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html#deprecated">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Deprecated API" class="title">Deprecated API</h1> +<h2 title="Contents">Contents</h2> +<ul> +<li><a href="#constructor">Constructors</a></li> +</ul> +</div> +<ul class="block-list"> +<li> +<div id="constructor"> +<div class="caption"><span>Deprecated Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-summary-item-name even-row-color"><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)">org.apache.datasketches.tuple.adouble.DoubleSketch<wbr>(Memory, DoubleSummary.Mode)</a></div> +<div class="col-last even-row-color"> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +<div class="col-summary-item-name odd-row-color"><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)">org.apache.datasketches.tuple.aninteger.IntegerSketch<wbr>(Memory, IntegerSummary.Mode)</a></div> +<div class="col-last odd-row-color"> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +<div class="col-summary-item-name even-row-color"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory)">org.apache.datasketches.tuple.strings.ArrayOfStringsSketch<wbr>(Memory)</a></div> +<div class="col-last even-row-color"> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +<div class="col-summary-item-name odd-row-color"><a href="org/apache/datasketches/tuple/UpdatableSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)">org.apache.datasketches.tuple.UpdatableSketch<wbr>(Memory, SummaryDeserializer<S>, SummaryFactory<S>)</a></div> +<div class="col-last odd-row-color"> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +</div> +</div> +</li> +</ul> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/element-list b/docs/7.0.X/element-list new file mode 100644 index 000000000..b6fda0169 --- /dev/null +++ b/docs/7.0.X/element-list @@ -0,0 +1,24 @@ +org.apache.datasketches +org.apache.datasketches.common +org.apache.datasketches.cpc +org.apache.datasketches.fdt +org.apache.datasketches.filters +org.apache.datasketches.filters.bloomfilter +org.apache.datasketches.frequencies +org.apache.datasketches.hash +org.apache.datasketches.hll +org.apache.datasketches.hllmap +org.apache.datasketches.kll +org.apache.datasketches.partitions +org.apache.datasketches.quantiles +org.apache.datasketches.quantilescommon +org.apache.datasketches.req +org.apache.datasketches.sampling +org.apache.datasketches.tdigest +org.apache.datasketches.theta +org.apache.datasketches.thetacommon +org.apache.datasketches.tuple +org.apache.datasketches.tuple.adouble +org.apache.datasketches.tuple.aninteger +org.apache.datasketches.tuple.arrayofdoubles +org.apache.datasketches.tuple.strings diff --git a/docs/7.0.X/help-doc.html b/docs/7.0.X/help-doc.html new file mode 100644 index 000000000..6b453bfb5 --- /dev/null +++ b/docs/7.0.X/help-doc.html @@ -0,0 +1,201 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>API Help (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="help"> +<meta name="generator" content="javadoc/HelpWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="help-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li class="nav-bar-cell1-rev">Help</li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Help: </li> +<li><a href="#help-navigation">Navigation</a> | </li> +<li><a href="#help-pages">Pages</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<h1 class="title">JavaDoc Help</h1> +<ul class="help-toc"> +<li><a href="#help-navigation">Navigation</a>: +<ul class="help-subtoc"> +<li><a href="#help-search">Search</a></li> +</ul> +</li> +<li><a href="#help-pages">Kinds of Pages</a>: +<ul class="help-subtoc"> +<li><a href="#overview">Overview</a></li> +<li><a href="#package">Package</a></li> +<li><a href="#class">Class or Interface</a></li> +<li><a href="#doc-file">Other Files</a></li> +<li><a href="#use">Use</a></li> +<li><a href="#tree">Tree (Class Hierarchy)</a></li> +<li><a href="#deprecated">Deprecated API</a></li> +<li><a href="#constant-values">Constant Field Values</a></li> +<li><a href="#serialized-form">Serialized Form</a></li> +<li><a href="#all-packages">All Packages</a></li> +<li><a href="#all-classes">All Classes and Interfaces</a></li> +<li><a href="#index">Index</a></li> +</ul> +</li> +</ul> +<hr> +<div class="sub-title"> +<h2 id="help-navigation">Navigation</h2> +Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-all.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a> +<section class="help-section" id="help-search"> +<h3>Search</h3> +<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p> +<ul class="help-section-list"> +<li><code>j.l.obj</code> will match "java.lang.Object"</li> +<li><code>InpStr</code> will match "java.io.InputStream"</li> +<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li> +</ul> +<p>Refer to the <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/javadoc-search-spec.html">Javadoc Search Specification</a> for a full description of search features.</p> +</section> +</div> +<hr> +<div class="sub-title"> +<h2 id="help-pages">Kinds of Pages</h2> +The following sections describe the different kinds of pages in this collection. +<section class="help-section" id="overview"> +<h3>Overview</h3> +<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p> +</section> +<section class="help-section" id="package"> +<h3>Package</h3> +<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:</p> +<ul class="help-section-list"> +<li>Interfaces</li> +<li>Classes</li> +<li>Enum Classes</li> +<li>Exceptions</li> +<li>Errors</li> +<li>Annotation Interfaces</li> +</ul> +</section> +<section class="help-section" id="class"> +<h3>Class or Interface</h3> +<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.</p> +<ul class="help-section-list"> +<li>Class Inheritance Diagram</li> +<li>Direct Subclasses</li> +<li>All Known Subinterfaces</li> +<li>All Known Implementing Classes</li> +<li>Class or Interface Declaration</li> +<li>Class or Interface Description</li> +</ul> +<br> +<ul class="help-section-list"> +<li>Nested Class Summary</li> +<li>Enum Constant Summary</li> +<li>Field Summary</li> +<li>Property Summary</li> +<li>Constructor Summary</li> +<li>Method Summary</li> +<li>Required Element Summary</li> +<li>Optional Element Summary</li> +</ul> +<br> +<ul class="help-section-list"> +<li>Enum Constant Details</li> +<li>Field Details</li> +<li>Property Details</li> +<li>Constructor Details</li> +<li>Method Details</li> +<li>Element Details</li> +</ul> +<p><span class="help-note">Note:</span> Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.</p> +<p>The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p> +</section> +<section class="help-section" id="doc-file"> +<h3>Other Files</h3> +<p>Packages and modules may contain pages with additional information related to the declarations nearby.</p> +</section> +<section class="help-section" id="use"> +<h3>Use</h3> +<p>Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.</p> +</section> +<section class="help-section" id="tree"> +<h3>Tree (Class Hierarchy)</h3> +<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with <code>java.lang.Object</code>. Interfaces do not inherit from <code>java.lang.Object</code>.</p> +<ul class="help-section-list"> +<li>When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.</li> +<li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li> +</ul> +</section> +<section class="help-section" id="deprecated"> +<h3>Deprecated API</h3> +<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p> +</section> +<section class="help-section" id="constant-values"> +<h3>Constant Field Values</h3> +<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> +</section> +<section class="help-section" id="serialized-form"> +<h3>Serialized Form</h3> +<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.</p> +</section> +<section class="help-section" id="all-packages"> +<h3>All Packages</h3> +<p>The <a href="allpackages-index.html">All Packages</a> page contains an alphabetic index of all packages contained in the documentation.</p> +</section> +<section class="help-section" id="all-classes"> +<h3>All Classes and Interfaces</h3> +<p>The <a href="allclasses-index.html">All Classes and Interfaces</a> page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.</p> +</section> +<section class="help-section" id="index"> +<h3>Index</h3> +<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p> +</section> +</div> +<hr> +<span class="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/index-all.html b/docs/7.0.X/index-all.html new file mode 100644 index 000000000..e3e0e1f0a --- /dev/null +++ b/docs/7.0.X/index-all.html @@ -0,0 +1,8489 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Index (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="index"> +<meta name="generator" content="javadoc/IndexWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="index-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="nav-bar-cell1-rev">Index</li> +<li><a href="help-doc.html#index">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1>Index</h1> +</div> +<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:K">K</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a href="#I:X">X</a> <a href="#I:Z">Z</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized Form</a> +<h2 class="title" id="I:A">A</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Family.html#A_NOT_B" class="member-name-link">A_NOT_B</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The A and not B family is an operation for the Theta Sketch Framework of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#ALPHA" class="member-name-link">ALPHA</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Alpha Sketch family is a member of the Theta Sketch Framework of sketches and is best + suited for real-time processes where both the updating of the sketch and getting the estimate + is performed directly on the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html#AlwaysOne" class="member-name-link">AlwaysOne</a> - Enum constant in enum class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is always one.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html#AlwaysOne" class="member-name-link">AlwaysOne</a> - Enum constant in enum class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is always one.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB(Sketch, Sketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as an + ordered CompactSketch on the heap.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">aNotB(Sketch, Sketch, boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as a + CompactSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB(Sketch<S>, Sketch)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">aNotB(Sketch<S>, Sketch<S>)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> +<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html" class="type-name-link" title="class in org.apache.datasketches.theta">AnotB</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple">AnotB</a><<a href="org/apache/datasketches/tuple/AnotB.html" title="type parameter in AnotB">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#%3Cinit%3E()" class="member-name-link">AnotB()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#%3Cinit%3E()" class="member-name-link">AnotB()</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html#approximateLowerBoundOnP(long,long,double)" class="member-name-link">approximateLowerBoundOnP(long, long, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></dt> +<dd> +<div class="block">Computes lower bound of approximate Clopper-Pearson confidence interval for a binomial + proportion.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html#approximateUpperBoundOnP(long,long,double)" class="member-name-link">approximateUpperBoundOnP(long, long, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></dt> +<dd> +<div class="block">Computes upper bound of approximate Clopper-Pearson confidence interval for a binomial + proportion.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html#approxNumDeltaItems" class="member-name-link">approxNumDeltaItems</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></dt> +<dd> +<div class="block">The approximate number of items represented by this partition description row.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Methods of serializing and deserializing arrays of Boolean as a bit array.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#%3Cinit%3E()" class="member-name-link">ArrayOfBooleansSerDe()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Computes a set difference of two tuple sketches of type ArrayOfDoubles</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Computes a set difference, A-AND-NOT-B, of two ArrayOfDoublesSketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html" class="type-name-link" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a> - Interface in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Combines two arrays of double values for use with ArrayOfDoubles tuple sketches</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Top level compact tuple sketch of type ArrayOfDoubles.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html#ArrayOfDoublesCompactSketch" class="member-name-link">ArrayOfDoublesCompactSketch</a> - Enum constant in enum class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></dt> +<dd> +<div class="block">ArrayOfDoublesCompactSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Computes the intersection of two or more tuple sketches of type ArrayOfDoubles.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html#ArrayOfDoublesQuickSelectSketch" class="member-name-link">ArrayOfDoublesQuickSelectSketch</a> - Enum constant in enum class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></dt> +<dd> +<div class="block">ArrayOfDoublesQuickSelectSketch</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Methods of serializing and deserializing arrays of Double.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesSerDe()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Builds set operations object for tuple sketches of type ArrayOfDoubles.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesSetOperationBuilder()</a> - Constructor for class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Creates an instance of the builder with default parameters</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values + is associated with each key.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Convenient static methods to instantiate tuple sketches of type ArrayOfDoubles.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesSketches()</a> - Constructor for class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a> - Interface in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">Interface for iterating over tuple sketches of type ArrayOfDoubles</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">The base class for unions of tuple sketches of type ArrayOfDoubles.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html#ArrayOfDoublesUnion" class="member-name-link">ArrayOfDoublesUnion</a> - Enum constant in enum class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></dt> +<dd> +<div class="block">ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a> - Class in <a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></dt> +<dd> +<div class="block">For building a new ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesUpdatableSketchBuilder()</a> - Constructor for class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">Creates an instance of builder with default parameters</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Base class for serializing and deserializing custom types.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#%3Cinit%3E()" class="member-name-link">ArrayOfItemsSerDe()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Methods of serializing and deserializing arrays of Long.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#%3Cinit%3E()" class="member-name-link">ArrayOfLongsSerDe()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Methods of serializing and deserializing arrays of the object version of primitive types of + Number.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#%3Cinit%3E()" class="member-name-link">ArrayOfNumbersSerDe()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSerDe()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> - Class in <a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSketch()</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></dt> +<dd> +<div class="block">Constructs new sketch with default <i>K</i> = 4096 (<i>lgK</i> = 12), default ResizeFactor=X8, + and default <i>p</i> = 1.0.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#%3Cinit%3E(int)" class="member-name-link">ArrayOfStringsSketch(int)</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></dt> +<dd> +<div class="block">Constructs new sketch with default ResizeFactor=X8, default <i>p</i> = 1.0 and given <i>lgK</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#%3Cinit%3E(int,org.apache.datasketches.common.ResizeFactor,float)" class="member-name-link">ArrayOfStringsSketch(int, ResizeFactor, float)</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></dt> +<dd> +<div class="block">Constructs new sketch with given ResizeFactor, <i>p</i> and <i>lgK</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory)" class="member-name-link">ArrayOfStringsSketch(Memory)</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#%3Cinit%3E(org.apache.datasketches.tuple.strings.ArrayOfStringsSketch)" class="member-name-link">ArrayOfStringsSketch(ArrayOfStringsSketch)</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></dt> +<dd> +<div class="block">Copy Constructor</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> - Class in <a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a> - Class in <a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSummaryDeserializer()</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a> - Class in <a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSummaryFactory()</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a> - Class in <a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSummarySetOperations()</a> - Constructor for class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#%3Cinit%3E()" class="member-name-link">ArrayOfUtf16StringsSerDe()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#asDouble(long%5B%5D)" class="member-name-link">asDouble(long[])</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns a uniform random double with a minimum inclusive value of zero and a maximum exclusive + value of 1.0.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#asInt(byte%5B%5D,int)" class="member-name-link">asInt(byte[], int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#asInt(double,int)" class="member-name-link">asInt(double, int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input double.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#asInt(int%5B%5D,int)" class="member-name-link">asInt(int[], int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#asInt(long%5B%5D,int)" class="member-name-link">asInt(long[], int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#asInt(long,int)" class="member-name-link">asInt(long, int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input datum.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#asInt(java.lang.String,int)" class="member-name-link">asInt(String, int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input datum.</div> +</dd> +</dl> +<h2 class="title" id="I:B">B</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/quantilescommon/BinarySearch.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">Contains common equality binary search algorithms.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/BinarySearch.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">BinarySearch</a> - Class in <a href="org/apache/datasketches/tdigest/package-summary.html">org.apache.datasketches.tdigest</a></dt> +<dd> +<div class="block">Algorithms with logarithmic complexity for searching in an array.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/BinarySearch.html#%3Cinit%3E()" class="member-name-link">BinarySearch()</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tdigest/BinarySearch.html#%3Cinit%3E()" class="member-name-link">BinarySearch()</a> - Constructor for class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/BinarySearch.html" title="class in org.apache.datasketches.tdigest">BinarySearch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/BinomialBoundsN.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a> - Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">This class enables the estimation of error bounds given a sample set size, the sampling + probability theta, the number of standard deviations and a simple noDataSeen flag.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#bitAt(long,int)" class="member-name-link">bitAt(long, int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns a one if the bit at bitPos is a one, otherwise zero.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/BitPacking.html" class="type-name-link" title="class in org.apache.datasketches.theta">BitPacking</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">Used as part of Theta compression.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/BitPacking.html#%3Cinit%3E()" class="member-name-link">BitPacking()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/BitPacking.html" title="class in org.apache.datasketches.theta">BitPacking</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> - Class in <a href="org/apache/datasketches/filters/bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a></dt> +<dd> +<div class="block">A Bloom filter is a data structure that can be used for probabilistic + set membership.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#BLOOMFILTER" class="member-name-link">BLOOMFILTER</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Bloom Filter</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a> - Class in <a href="org/apache/datasketches/filters/bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a></dt> +<dd> +<div class="block">This class provides methods to help estimate the correct parameters when + creating a Bloom filter, and methods to create the filter using those values.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#%3Cinit%3E()" class="member-name-link">BloomFilterBuilder()</a> - Constructor for class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" class="type-name-link" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Confidence intervals for binomial proportions.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" class="type-name-link" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>|B| / |A|</i>, where: + + <i>|A|</i> is the unknown size of a set <i>A</i> of unique identifiers. + <i>|B|</i> is the unknown size of a subset <i>B</i> of <i>A</i>. + <i>a</i> = <i>|S<sub>A</sub>|</i> is the observed size of a sample of <i>A</i> + that was obtained by Bernoulli sampling with a known inclusion probability <i>f</i>. + <i>b</i> = <i>|S<sub>A</sub> ∩ B|</i> is the observed size of a subset + of <i>S<sub>A</sub></i>. + </div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a> - Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + + <i>A</i> is a Theta Sketch of population <i>PopA</i>. + <i>B</i> is a Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Theta Sketch <i>C</i>, + which acts like a predicate or selection clause. + The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). + The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). + The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). + + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a> - Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + + <i>A</i> is a Tuple Sketch of population <i>PopA</i>. + <i>B</i> is a Tuple or Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Tuple or Theta Sketch <i>C</i>, + which acts like a predicate or selection clause. + The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). + The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). + The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). + + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/BoundsRule.html" class="type-name-link" title="enum class in org.apache.datasketches.partitions">BoundsRule</a> - Enum Class in <a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></dt> +<dd> +<div class="block">This instructs the user about which of the upper and lower bounds of a partition definition row + should be included with the returned data.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></dt> +<dd> +<div class="block">Returns an UpdateDoublesSketch with the current configuration of this Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></dt> +<dd> +<div class="block">Returns a new empty Union object with the current configuration of this Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">Returns a new ReqSketch with the current configuration of the builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></dt> +<dd> +<div class="block">Returns an UpdatableSketch with the current configuration of this Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#build(org.apache.datasketches.common.Family)" class="member-name-link">build(Family)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build(Family, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family + and the given destination memory.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build(WritableMemory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></dt> +<dd> +<div class="block">Returns a quantiles UpdateDoublesSketch with the current configuration of this builder + and the specified backing destination Memory store.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build(WritableMemory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></dt> +<dd> +<div class="block">Returns a new empty Union object with the current configuration of this Builder + and the specified backing destination Memory store.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build(WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder + with the specified backing destination Memory store.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#buildAnotB()" class="member-name-link">buildAnotB()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Creates an instance of ArrayOfDoublesAnotB based on the current configuration of the builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#buildANotB()" class="member-name-link">buildANotB()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Convenience method, returns a configured SetOperation ANotB with + <a href="./resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#builder()" class="member-name-link">builder()</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns a new builder</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#builder()" class="member-name-link">builder()</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns a new UnionBuilder</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#builder()" class="member-name-link">builder()</a> - Static method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> +<div class="block">Returns a new ReqSketchBuilder</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#builder()" class="member-name-link">builder()</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Makes a new builder</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#builder()" class="member-name-link">builder()</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Returns a new builder</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#buildIntersection()" class="member-name-link">buildIntersection()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="./resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#buildIntersection()" class="member-name-link">buildIntersection()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#buildIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildIntersection(WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="./resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#buildIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildIntersection(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#buildLocal(org.apache.datasketches.theta.UpdateSketch)" class="member-name-link">buildLocal(UpdateSketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns a local, on-heap, concurrent UpdateSketch to be used as a per-thread local buffer + along with the given concurrent shared UpdateSketch and the current configuration of this + Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#buildShared()" class="member-name-link">buildShared()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns an on-heap concurrent shared UpdateSketch with the current configuration of the + Builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#buildShared(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildShared(WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder and the given destination WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#buildSharedFromSketch(org.apache.datasketches.theta.UpdateSketch,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildSharedFromSketch(UpdateSketch, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder, the data from the given sketch, and the given destination + WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#buildUnion()" class="member-name-link">buildUnion()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="./resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#buildUnion()" class="member-name-link">buildUnion()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#buildUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildUnion(WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="./resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#buildUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildUnion(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder + and the given destination memory.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html" class="type-name-link" title="class in org.apache.datasketches.common">ByteArrayUtil</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Useful methods for byte arrays.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#%3Cinit%3E()" class="member-name-link">ByteArrayUtil()</a> - Constructor for class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/Util.html#bytesToInt(byte%5B%5D)" class="member-name-link">bytesToInt(byte[])</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns an int extracted from a Little-Endian byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#bytesToLong(byte%5B%5D)" class="member-name-link">bytesToLong(byte[])</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns a long extracted from a Little-Endian byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#bytesToString(byte%5B%5D,boolean,boolean,java.lang.String)" class="member-name-link">bytesToString(byte[], boolean, boolean, String)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns a string view of a byte array</div> +</dd> +</dl> +<h2 class="title" id="I:C">C</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#caseIdToCornerCase(int)" class="member-name-link">caseIdToCornerCase(int)</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Converts caseId to CornerCaseId</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#ceilingPowerBaseOfDouble(double,double)" class="member-name-link">ceilingPowerBaseOfDouble(double, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the ceiling of a given <i>n</i> given a <i>base</i>, where the ceiling is an integral power of the base.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#ceilingPowerOf2(int)" class="member-name-link">ceilingPowerOf2(int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the int ceiling power of 2 within the range [1, 2^30].</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#ceilingPowerOf2(long)" class="member-name-link">ceilingPowerOf2(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the long ceiling power of 2 within the range [1, 2^62].</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#characterPad(java.lang.String,int,char,boolean)" class="member-name-link">characterPad(String, int, char, boolean)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Prepend or postpend the given string with the given character to fill the given field length.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#checkBounds(long,long,long)" class="member-name-link">checkBounds(long, long, long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Check the requested offset and length against the allocated size.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#checkDoublesSplitPointsOrder(double%5B%5D)" class="member-name-link">checkDoublesSplitPointsOrder(double[])</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Checks the sequential validity of the given array of double values.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#checkFamilyID(int)" class="member-name-link">checkFamilyID(int)</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#checkFloatsSplitPointsOrder(float%5B%5D)" class="member-name-link">checkFloatsSplitPointsOrder(float[])</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Checks the sequential validity of the given array of float values.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#checkHashCorruption(long)" class="member-name-link">checkHashCorruption(long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/Util.html#checkIfMultipleOf8AndGT0(long,java.lang.String)" class="member-name-link">checkIfMultipleOf8AndGT0(long, String)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Checks if parameter v is a multiple of 8 and greater than zero.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#checkIfPowerOf2(long,java.lang.String)" class="member-name-link">checkIfPowerOf2(long, String)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Checks the given long argument if it is a positive integer power of 2.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#checkLongsSplitPointsOrder(long%5B%5D)" class="member-name-link">checkLongsSplitPointsOrder(long[])</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Checks the sequential validity of the given array of double values.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#checkNomLongs(int)" class="member-name-link">checkNomLongs(int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">Checks that the given nomLongs is within bounds and returns the Log2 of the ceiling power of 2 + of the given nomLongs.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#checkNormalizedRankBounds(double)" class="member-name-link">checkNormalizedRankBounds(double)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Checks that the given normalized rank: <i>0 ≤ nRank ≤ 1.0</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#checkProbability(double,java.lang.String)" class="member-name-link">checkProbability(double, String)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Checks the given parameter to make sure it is positive and between 0.0 inclusive and 1.0 + inclusive.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#checkSeedHashes(short,short)" class="member-name-link">checkSeedHashes(short, short)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">Check if the two seed hashes are equal.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#checkSeedHashes(short,short)" class="member-name-link">checkSeedHashes(short, short)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Checks the two given seed hashes.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#checkThetaCorruption(long)" class="member-name-link">checkThetaCorruption(long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ClassicUtil.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ClassicUtil</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">Utilities for the classic quantiles sketches and independent of the type.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html#combine(double%5B%5D,double%5B%5D)" class="member-name-link">combine(double[], double[])</a> - Method in interface org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></dt> +<dd> +<div class="block">Method of combining two arrays of double values</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html#compact()" class="member-name-link">compact()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#compact()" class="member-name-link">compact()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Converts this sketch to a ordered CompactSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#compact()" class="member-name-link">compact()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#compact()" class="member-name-link">compact()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Gets an on-heap compact representation of the sketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/CompactSketch.html#compact()" class="member-name-link">compact()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#compact()" class="member-name-link">compact()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#compact()" class="member-name-link">compact()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Converts this sketch to a CompactSketch on the Java heap.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact(boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact(boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Convert this sketch to a <i>CompactSketch</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact(boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact(WritableMemory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></dt> +<dd> +<div class="block">Returns a compact version of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Gets an off-heap compact representation of the sketch using the given memory</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#COMPACT" class="member-name-link">COMPACT</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Compact Sketch family is a member of the Theta Sketch Framework of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#COMPACT_EMPTY" class="member-name-link">COMPACT_EMPTY</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">Compact Empty Structure</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#COMPACT_FULL" class="member-name-link">COMPACT_FULL</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">Compact Full Preamble Structure</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#COMPACT_SINGLE" class="member-name-link">COMPACT_SINGLE</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">Compact Single Item Structure</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">CompactSketch</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">The parent class of all the CompactSketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="org/apache/datasketches/tuple/CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">CompactSketches are never created directly.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html#CompactSketch" class="member-name-link">CompactSketch</a> - Enum constant in enum class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></dt> +<dd> +<div class="block">CompactSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#%3Cinit%3E()" class="member-name-link">CompactSketch()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#compareTo(org.apache.datasketches.fdt.Group)" class="member-name-link">compareTo(Group)</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#compareTo(org.apache.datasketches.frequencies.ItemsSketch.Row)" class="member-name-link">compareTo(ItemsSketch.Row<T>)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#compareTo(org.apache.datasketches.frequencies.LongsSketch.Row)" class="member-name-link">compareTo(LongsSketch.Row)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CompressionCharacterization.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CompressionCharacterization.html#%3Cinit%3E(int,int,int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">CompressionCharacterization(int, int, int, int, int, int, int, PrintStream, PrintWriter)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CompressionCharacterization.html" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a></dt> +<dd> +<div class="block">Only used in test.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#computeBytesNeeded(int)" class="member-name-link">computeBytesNeeded(int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> +<div class="block">Computes number of bytes needed for packed bit encoding of the array of booleans.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html#computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesDoublesAPI,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)" class="member-name-link">computeKSDelta(QuantilesDoublesAPI, QuantilesDoublesAPI)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></dt> +<dd> +<div class="block">Computes the raw delta between two QuantilesDoublesAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html#computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesFloatsAPI,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)" class="member-name-link">computeKSDelta(QuantilesFloatsAPI, QuantilesFloatsAPI)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></dt> +<dd> +<div class="block">Computes the raw delta between two QuantilesFloatsAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html#computeKSThreshold(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)" class="member-name-link">computeKSThreshold(QuantilesAPI, QuantilesAPI, double)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></dt> +<dd> +<div class="block">Computes the adjusted delta height threshold for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#computeSeedHash(long)" class="member-name-link">computeSeedHash(long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">Computes and checks the 16-bit seed hash from the given long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#computeSeedHash(long)" class="member-name-link">computeSeedHash(long)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Computes and checks the 16-bit seed hash from the given long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#ConcurrentBufferInserted" class="member-name-link">ConcurrentBufferInserted</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was inserted into the local concurrent buffer, + but has not yet been propagated to the concurrent shared sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#ConcurrentPropagated" class="member-name-link">ConcurrentPropagated</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash has been propagated to the concurrent shared sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#continueCondition(long,long)" class="member-name-link">continueCondition(long, long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">Return true (continue) if hash is greater than or equal to thetaLong, or if hash == 0, + or if hash == Long.MAX_VALUE.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#convertToHashTable(long%5B%5D,int,long,double)" class="member-name-link">convertToHashTable(long[], int, long, double)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">Converts the given array to a hash table.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#copy()" class="member-name-link">copy()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#copy()" class="member-name-link">copy()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Return a copy of this sketch onto the Java heap.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html#copy()" class="member-name-link">copy()</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html#copy()" class="member-name-link">copy()</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#copy()" class="member-name-link">copy()</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html#copy()" class="member-name-link">copy()</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Summary.html#copy()" class="member-name-link">copy()</a> - Method in interface org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></dt> +<dd> +<div class="block">Deep copy.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#copy()" class="member-name-link">copy()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#copyAs(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">copyAs(TgtHllType)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Return a deep copy of this sketch onto the Java heap with the specified TgtHllType.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#copyBytes(byte%5B%5D,int,byte%5B%5D,int,int)" class="member-name-link">copyBytes(byte[], int, byte[], int, int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Copies bytes from source to target with offsets on both the source and target.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#copySummaryArray(S%5B%5D)" class="member-name-link">copySummaryArray(S[])</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#count(long%5B%5D,long)" class="member-name-link">count(long[], long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">Counts the cardinality of the given source array.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#COUNTMIN" class="member-name-link">COUNTMIN</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">CountMin Sketch</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#countPart(long%5B%5D,int,long)" class="member-name-link">countPart(long[], int, long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">Counts the cardinality of the first Log2 values of the given source array.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#CPC" class="member-name-link">CPC</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Compressed Probabilistic Counting (CPC) Sketch</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcSketch</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> +<div class="block">This is a unique-counting sketch that implements the + <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in + his paper + <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly + Optimal Cardinality Estimation Algorithm</a>.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#%3Cinit%3E()" class="member-name-link">CpcSketch()</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Constructor with default log_base2 of k</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#%3Cinit%3E(int)" class="member-name-link">CpcSketch(int)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Constructor with log_base2 of k.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#%3Cinit%3E(int,long)" class="member-name-link">CpcSketch(int, long)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Constructor with log_base2 of k and seed.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcUnion</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> +<div class="block">The union (merge) operation for the CPC sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html#%3Cinit%3E()" class="member-name-link">CpcUnion()</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></dt> +<dd> +<div class="block">Construct this unioning object with the default LgK and the default update seed.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html#%3Cinit%3E(int)" class="member-name-link">CpcUnion(int)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></dt> +<dd> +<div class="block">Construct this unioning object with LgK and the default update seed.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html#%3Cinit%3E(int,long)" class="member-name-link">CpcUnion(int, long)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></dt> +<dd> +<div class="block">Construct this unioning object with LgK and a given seed.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcWrapper</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> +<div class="block">This provides a read-only view of a serialized image of a CpcSketch, which can be + on-heap or off-heap represented as a Memory object, or on-heap represented as a byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html#%3Cinit%3E(byte%5B%5D)" class="member-name-link">CpcWrapper(byte[])</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></dt> +<dd> +<div class="block">Construct a read-only view of the given byte array that contains a CpcSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html#%3Cinit%3E(org.apache.datasketches.memory.Memory)" class="member-name-link">CpcWrapper(Memory)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></dt> +<dd> +<div class="block">Construct a read-only view of the given Memory that contains a CpcSketch</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#createByAccuracy(long,double)" class="member-name-link">createByAccuracy(long, double)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#createByAccuracy(long,double,long)" class="member-name-link">createByAccuracy(long, double, long)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#createBySize(long,int)" class="member-name-link">createBySize(long, int)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using a rnadom base seed for the hash function.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#createBySize(long,int,long)" class="member-name-link">createBySize(long, int, long)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html#createCornerCaseId(long,int,boolean,long,int,boolean)" class="member-name-link">createCornerCaseId(long, int, boolean, long, int, boolean)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></dt> +<dd> +<div class="block">Creates the CornerCase ID</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketches.html#createEmptySketch()" class="member-name-link">createEmptySketch()</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html#cumWeights" class="member-name-link">cumWeights</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></dt> +<dd> +<div class="block">the array of associated cumulative weights</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html#cumWeights" class="member-name-link">cumWeights</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></dt> +<dd> +<div class="block">The array of associated cumulative weights</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html#cumWeights" class="member-name-link">cumWeights</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a></dt> +<dd> +<div class="block">The array of associated cumulative weights</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html#cumWeights" class="member-name-link">cumWeights</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></dt> +<dd> +<div class="block">the array of associated cumulative weights</div> +</dd> +</dl> +<h2 class="title" id="I:D">D</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#DEFAULT_HLL_TYPE" class="member-name-link">DEFAULT_HLL_TYPE</a> - Static variable in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">The default HLL-TYPE is HLL_4</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#DEFAULT_K" class="member-name-link">DEFAULT_K</a> - Static variable in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">The default K</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#DEFAULT_K" class="member-name-link">DEFAULT_K</a> - Static variable in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">the default value of K if one is not specified</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#DEFAULT_LG_K" class="member-name-link">DEFAULT_LG_K</a> - Static variable in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">The default Log_base2 of K</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#DEFAULT_LG_K" class="member-name-link">DEFAULT_LG_K</a> - Static variable in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">The default Log_base2 of K</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#DEFAULT_NOMINAL_ENTRIES" class="member-name-link">DEFAULT_NOMINAL_ENTRIES</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">The default nominal entries is provided as a convenience for those cases where the + nominal sketch size in number of entries is not provided.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#DEFAULT_NOMINAL_ENTRIES" class="member-name-link">DEFAULT_NOMINAL_ENTRIES</a> - Static variable in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Default Nominal Entries (a.k.a.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#DEFAULT_NUMBER_OF_VALUES" class="member-name-link">DEFAULT_NUMBER_OF_VALUES</a> - Static variable in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Default number of values</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#DEFAULT_UPDATE_SEED" class="member-name-link">DEFAULT_UPDATE_SEED</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">The seed 9001 used in the sketch update methods is a prime number that + was chosen very early on in experimental testing.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Degen_Degen" class="member-name-link">Degen_Degen</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Degen_Degen</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Degen_Empty" class="member-name-link">Degen_Empty</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Degen_Empty</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Degen_Estimation" class="member-name-link">Degen_Estimation</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Degen_Estimation</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Degen_Exact" class="member-name-link">Degen_Exact</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Degen_Exact</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#DEGEN_MIN_0_F" class="member-name-link">DEGEN_MIN_0_F</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html#DEGEN_MIN_0_F" class="member-name-link">DEGEN_MIN_0_F</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></dt> +<dd> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#DEGEN_MIN_0_F" class="member-name-link">DEGEN_MIN_0_F</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#DEGEN_THA_0_F" class="member-name-link">DEGEN_THA_0_F</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Degenerate{ThetaA, 0, F}</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#DEGEN_THA_0_F" class="member-name-link">DEGEN_THA_0_F</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Degenerate{ThetaA, 0, F}</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#DEGEN_THB_0_F" class="member-name-link">DEGEN_THB_0_F</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Degenerate{ThetaB, 0, F}</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#desc(double%5B%5D,int,int,double,int)" class="member-name-link">desc(double[], int, int, double, int)</a> - Method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Optional call that describes the details of the results of the search.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#desc(float%5B%5D,int,int,float,int)" class="member-name-link">desc(float[], int, int, float, int)</a> - Method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Optional call that describes the details of the results of the search.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#desc(long%5B%5D,int,int,double,int)" class="member-name-link">desc(long[], int, int, double, int)</a> - Method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Optional call that describes the details of the results of the search.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#desc(long%5B%5D,int,int,long,int)" class="member-name-link">desc(long[], int, int, long, int)</a> - Method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Optional call that describes the details of the results of the search.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory(Memory, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory(Memory, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory(Memory, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory(Memory, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory(Memory, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory(Memory, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory(Memory, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/DeserializeResult.html" class="type-name-link" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="org/apache/datasketches/tuple/DeserializeResult.html" title="type parameter in DeserializeResult">T</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/DeserializeResult.html#%3Cinit%3E(T,int)" class="member-name-link">DeserializeResult(T, int)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></dt> +<dd> +<div class="block">Creates an instance.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a> - Class in <a href="org/apache/datasketches/filters/bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a></dt> +<dd> +<div class="block">This class can maintain the BitArray object off-heap.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)" class="member-name-link">dissimilarityTest(Sketch, Sketch, double)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></dt> +<dd> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest(Sketch<S>, Sketch, S, SummarySetOperations<S>, double)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest(Sketch<S>, Sketch<S>, SummarySetOperations<S>, double)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#DOUBLES_SKETCH" class="member-name-link">DOUBLES_SKETCH</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">KllDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a> - Class in <a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch(int, int, float, DoubleSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></dt> +<dd> +<div class="block">Creates this sketch with the following parameters:</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html#%3Cinit%3E(int,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch(int, DoubleSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></dt> +<dd> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch(Memory, DoubleSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html#%3Cinit%3E(double%5B%5D,long%5B%5D)" class="member-name-link">DoublesPair(double[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">For building a new quantiles DoublesSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html#%3Cinit%3E()" class="member-name-link">DoublesSketchBuilder()</a> - Constructor for class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></dt> +<dd> +<div class="block">Constructor for a new DoublesSketchBuilder.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">Iterator over DoublesSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#%3Cinit%3E(double%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)" class="member-name-link">DoublesSketchSortedView(double[], long[], QuantilesDoublesAPI)</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> +<div class="block">Construct from elements, also used in testing.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Sorted View for quantile sketches of primitive type double.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">Iterator over quantile sketches of primitive type <i>double</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html#%3Cinit%3E(double%5B%5D,long%5B%5D)" class="member-name-link">DoublesSortedViewIterator(double[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> - Class in <a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></dt> +<dd> +<div class="block">Summary for generic tuple sketches of type Double.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummary(DoubleSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></dt> +<dd> +<div class="block">Creates an instance of DoubleSummary with a given mode.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> - Enum Class in <a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></dt> +<dd> +<div class="block">The aggregation modes for this Summary</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a> - Class in <a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html#%3Cinit%3E()" class="member-name-link">DoubleSummaryDeserializer()</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a> - Class in <a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></dt> +<dd> +<div class="block">Factory for DoubleSummary.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummaryFactory(DoubleSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a></dt> +<dd> +<div class="block">Creates an instance of DoubleSummaryFactory with a given mode</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a> - Class in <a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></dt> +<dd> +<div class="block">Methods for defining how unions and intersections of two objects of type DoubleSummary + are performed.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html#%3Cinit%3E()" class="member-name-link">DoubleSummarySetOperations()</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></dt> +<dd> +<div class="block">Creates an instance with default mode of <i>sum</i> for both union and intersection.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummarySetOperations(DoubleSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></dt> +<dd> +<div class="block">Creates an instance given a DoubleSummary update mode where the mode is the same for both + union and intersection.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummarySetOperations(DoubleSummary.Mode, DoubleSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></dt> +<dd> +<div class="block">Creates an instance with two modes.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesUnion</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">The API for Union operations for quantiles DoublesSketches</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#%3Cinit%3E()" class="member-name-link">DoublesUnion()</a> - Constructor for class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">For building a new DoublesSketch Union operation.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html#%3Cinit%3E()" class="member-name-link">DoublesUnionBuilder()</a> - Constructor for class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></dt> +<dd> +<div class="block">Constructor for a new DoublesUnionBuilder.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#doubleToLongArray(double)" class="member-name-link">doubleToLongArray(double)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Converts a <i>double</i> to a <i>long[]</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#downSample(int)" class="member-name-link">downSample(int)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">From an existing sketch, this creates a new sketch that can have a smaller K.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">downSample(DoublesSketch, int, WritableMemory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">From an source sketch, create a new sketch that must have a smaller K.</div> +</dd> +</dl> +<h2 class="title" id="I:E">E</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Family.html#EBPPS" class="member-name-link">EBPPS</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Exact and Bounded, Probability Proportional to Size (EBPPS)</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">An implementation of an Exact and Bounded Sampling Proportional to Size sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#%3Cinit%3E(int)" class="member-name-link">EbppsItemsSketch(int)</a> - Constructor for class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Constructor</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitAdjSecSizeNumSec(byte)" class="member-name-link">emitAdjSecSizeNumSec(byte)</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit adjusting section size and number of sections.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitAllHorizList()" class="member-name-link">emitAllHorizList()</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit all horizontal lists</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitCompactingStart(byte)" class="member-name-link">emitCompactingStart(byte)</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit Compaction Start.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitCompactionDetail(int,int,int,int,boolean)" class="member-name-link">emitCompactionDetail(int, int, int, int, boolean)</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit Compaction details.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitCompactionDone(byte)" class="member-name-link">emitCompactionDone(byte)</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit compaction done and number of compactions so far.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitCompressDone()" class="member-name-link">emitCompressDone()</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit compress done.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitMustAddCompactor()" class="member-name-link">emitMustAddCompactor()</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit Must add compactor</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitNewCompactor(byte)" class="member-name-link">emitNewCompactor(byte)</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit new compactor configuration</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitStart(org.apache.datasketches.req.ReqSketch)" class="member-name-link">emitStart(ReqSketch)</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit the start signal</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html#emitStartCompress()" class="member-name-link">emitStartCompress()</a> - Method in interface org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></dt> +<dd> +<div class="block">Emit Start Compress</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#EMPTY_1_0_T" class="member-name-link">EMPTY_1_0_T</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Empty{1.0, 0, T}</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html#EMPTY_1_0_T" class="member-name-link">EMPTY_1_0_T</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></dt> +<dd> +<div class="block">Empty{1.0, 0, T</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#EMPTY_1_0_T" class="member-name-link">EMPTY_1_0_T</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Empty{1.0, 0, T}</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Empty_Degen" class="member-name-link">Empty_Degen</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Empty Degen</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Empty_Empty" class="member-name-link">Empty_Empty</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Empty Empty</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Empty_Estimation" class="member-name-link">Empty_Estimation</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Empty Estimation</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Empty_Exact" class="member-name-link">Empty_Exact</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Empty Exact</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#EMPTY_MSG" class="member-name-link">EMPTY_MSG</a> - Static variable in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">The sketch must not be empty for this operation.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html#EQ" class="member-name-link">EQ</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#EQ" class="member-name-link">EQ</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#equallySpacedDoubles(int)" class="member-name-link">equallySpacedDoubles(int)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Returns an array of (<i>num</i> + 1) values that define equally sized intervals between 0.0, inclusive, and 1.0, + inclusive.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#equallySpacedLongs(long,long,int)" class="member-name-link">equallySpacedLongs(long, long, int)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Returns an array of (<i>num</i> + 1) longs that define, approximately, equally spaced intervals between the given + <i>max</i>, inclusive, and <i>min</i>, inclusive.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> +<div class="block">This equals is computed only from the Row.getEstimate() value and does not imply equality + of the other items within the row: item and upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> +<div class="block">This equals is computed only from the Row.getEstimate() value and does not imply equality + of the other items within the row: item and upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html#erf(double)" class="member-name-link">erf(double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></dt> +<dd> +<div class="block">Computes an approximation to the erf() function.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ErrorType.html" class="type-name-link" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> - Enum Class in <a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></dt> +<dd> +<div class="block">Specifies one of two types of error regions of the statistical classification Confusion Matrix + that can be excluded from a returned sample of Frequent Items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum(Predicate<Long>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum(Predicate<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum(Predicate<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html#estimateUnknownP(long,long)" class="member-name-link">estimateUnknownP(long, long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></dt> +<dd> +<div class="block">Computes an estimate of an unknown binomial proportion.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Estimation_Degen" class="member-name-link">Estimation_Degen</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Estimation_Degen</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Estimation_Empty" class="member-name-link">Estimation_Empty</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Estimation_Empty</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Estimation_Estimation" class="member-name-link">Estimation_Estimation</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Estimation_Estimation</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Estimation_Exact" class="member-name-link">Estimation_Exact</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Estimation_Exact</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#evenlyLogSpaced(double,double,int)" class="member-name-link">evenlyLogSpaced(double, double, int)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Returns a double array of values between min and max inclusive where the log of the + returned values are evenly spaced.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#evenlySpacedDoubles(double,double,int)" class="member-name-link">evenlySpacedDoubles(double, double, int)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Returns a double array of evenly spaced values between value1, inclusive, and value2 inclusive.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#evenlySpacedFloats(float,float,int)" class="member-name-link">evenlySpacedFloats(float, float, int)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Returns a float array of evenly spaced values between value1, inclusive, and value2 inclusive.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Exact_Degen" class="member-name-link">Exact_Degen</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Exact Degen</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Exact_Empty" class="member-name-link">Exact_Empty</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Exact Empty</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Exact_Estimation" class="member-name-link">Exact_Estimation</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Exact Estimation</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#Exact_Exact" class="member-name-link">Exact_Exact</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Exact Exact</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#exactLog2OfInt(int)" class="member-name-link">exactLog2OfInt(int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the log2 of the given int value if it is an exact power of 2 and greater than zero.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#exactLog2OfInt(int,java.lang.String)" class="member-name-link">exactLog2OfInt(int, String)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the log2 of the given int value if it is an exact power of 2 and greater than zero.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#exactLog2OfLong(long)" class="member-name-link">exactLog2OfLong(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the log2 of the given long value if it is an exact power of 2 and greater than zero.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#exactLog2OfLong(long,java.lang.String)" class="member-name-link">exactLog2OfLong(long, String)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the log2 of the given long value if it is an exact power of 2 and greater than zero.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">exactlyEqual(Sketch, Sketch)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></dt> +<dd> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual(Sketch<S>, Sketch, S, SummarySetOperations<S>)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual(Sketch<S>, Sketch<S>, SummarySetOperations<S>)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html#EXCLUSIVE" class="member-name-link">EXCLUSIVE</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></dt> +<dd> +<div class="block"><b>Definition of EXCLUSIVE <i>getQuantile(r)</i> search:</b><br> + Given rank <i>r</i>, return the quantile of the smallest rank that is + strictly greater than <i>r</i>.</div> +</dd> +</dl> +<h2 class="title" id="I:F">F</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Family.html" class="type-name-link" title="enum class in org.apache.datasketches.common">Family</a> - Enum Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Defines the various families of sketch and set operation classes.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html" class="type-name-link" title="class in org.apache.datasketches.fdt">FdtSketch</a> - Class in <a href="org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a></dt> +<dd> +<div class="block">A Frequent Distinct Tuples sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#%3Cinit%3E(double,double)" class="member-name-link">FdtSketch(double, double)</a> - Constructor for class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> +<div class="block">Create a new instance of Frequent Distinct Tuples sketch with a size determined by the given + threshold and rse.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#%3Cinit%3E(int)" class="member-name-link">FdtSketch(int)</a> - Constructor for class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> +<div class="block">Create new instance of Frequent Distinct Tuples sketch with the given + Log-base2 of required nominal entries.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch)" class="member-name-link">FdtSketch(FdtSketch)</a> - Constructor for class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> +<div class="block">Copy Constructor</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Filter.html#filter(org.apache.datasketches.tuple.Sketch)" class="member-name-link">filter(Sketch<T>)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Filter.html" title="class in org.apache.datasketches.tuple">Filter</a></dt> +<dd> +<div class="block">Filters elements on the provided <a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Filter.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Filter</a><<a href="org/apache/datasketches/tuple/Filter.html" title="type parameter in Filter">T</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Class for filtering entries from a <a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Filter.html#%3Cinit%3E(java.util.function.Predicate)" class="member-name-link">Filter(Predicate<T>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Filter.html" title="class in org.apache.datasketches.tuple">Filter</a></dt> +<dd> +<div class="block">Filter constructor with a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link"><code>Predicate</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/BinarySearch.html#find(double%5B%5D,int,int,double)" class="member-name-link">find(double[], int, int, double)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the exact double value in the given search range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#find(double%5B%5D,int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find(double[], int, int, double, InequalitySearch)</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/BinarySearch.html#find(float%5B%5D,int,int,float)" class="member-name-link">find(float[], int, int, float)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the exact float value in the given search range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#find(float%5B%5D,int,int,float,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find(float[], int, int, float, InequalitySearch)</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the float value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#find(long%5B%5D,int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find(long[], int, int, double, InequalitySearch)</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/BinarySearch.html#find(long%5B%5D,int,int,long)" class="member-name-link">find(long[], int, int, long)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the exact long value in the given search range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#find(long%5B%5D,int,int,long,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find(long[], int, int, long, InequalitySearch)</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the long value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.html#find(T%5B%5D,int,int,T,org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality,java.util.Comparator)" class="member-name-link">find(T[], int, int, T, GenericInequalitySearch.Inequality, Comparator<T>)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.html" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></dt> +<dd> +<div class="block">Binary Search for the index of the generic value in the given search range that satisfies + the given Inequality criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#FLOATS_SKETCH" class="member-name-link">FLOATS_SKETCH</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">KllFloatsSketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html#%3Cinit%3E(float%5B%5D,long%5B%5D)" class="member-name-link">FloatsPair(float[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#%3Cinit%3E(float%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)" class="member-name-link">FloatsSketchSortedView(float[], long[], QuantilesFloatsAPI)</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> +<div class="block">Construct Sorted View.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Sorted View for quantiles of primitive type float.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">Iterator over quantile sketches of primitive type <i>float</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html#%3Cinit%3E(float%5B%5D,long%5B%5D)" class="member-name-link">FloatsSortedViewIterator(float[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#floorPowerBaseOfDouble(double,double)" class="member-name-link">floorPowerBaseOfDouble(double, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the floor of a given <i>n</i> given <i>base</i>, where the floor is an integral power of the base.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#floorPowerOf2(int)" class="member-name-link">floorPowerOf2(int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the floor power of 2 given <i>n</i> is in the range [1, 2^31-1].</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#floorPowerOf2(long)" class="member-name-link">floorPowerOf2(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the floor power of 2 given <i>n</i> is in the range [1, 2^63-1].</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#FREQUENCY" class="member-name-link">FREQUENCY</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Frequency family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory(Memory)</a> - Static method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></dt> +<dd> +<div class="block">Creates an instance of the DoubleSummary given a serialized representation</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory(Memory)</a> - Static method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></dt> +<dd> +<div class="block">Creates an instance of the IntegerSummary given a serialized representation</div> +</dd> +<dt><a href="org/apache/datasketches/hll/TgtHllType.html#fromOrdinal(int)" class="member-name-link">fromOrdinal(int)</a> - Static method in enum class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></dt> +<dd> +<div class="block">Convert the typeId to the enum type</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#FULL_ANOTB" class="member-name-link">FULL_ANOTB</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Full AnotB</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html#FULL_INTERSECT" class="member-name-link">FULL_INTERSECT</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></dt> +<dd> +<div class="block">Full Intersect</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#FULL_UNION" class="member-name-link">FULL_UNION</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Full Union</div> +</dd> +</dl> +<h2 class="title" id="I:G">G</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html#GE" class="member-name-link">GE</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A < V ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#GE" class="member-name-link">GE</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A < V ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.html#%3Cinit%3E()" class="member-name-link">GenericInequalitySearch()</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.html" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a> - Enum Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The enumerator of inequalities</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a>> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#%3Cinit%3E(long,T%5B%5D,long%5B%5D,double%5B%5D,T,T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">GenericPartitionBoundaries(long, T[], long[], double[], T, T, QuantileSearchCriteria)</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="type parameter in GenericSortedView">T</a>> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Sorted View for quantiles of generic type.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a>> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">Iterator over quantile sketches of generic type.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html#%3Cinit%3E(T%5B%5D,long%5B%5D)" class="member-name-link">GenericSortedViewIterator(T[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></dt> +<dd> +<div class="block">Constructor</div> +</dd> +<dt><a href="org/apache/datasketches/theta/HashIterator.html#get()" class="member-name-link">get()</a> - Method in interface org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></dt> +<dd> +<div class="block">Gets the hash value</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#getActionDescription()" class="member-name-link">getActionDescription()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Gets the action description</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html#getActionDescription()" class="member-name-link">getActionDescription()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></dt> +<dd> +<div class="block">Gets the Action Description</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#getActionDescription()" class="member-name-link">getActionDescription()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Gets the action description</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#getActionId()" class="member-name-link">getActionId()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Gets the Action ID</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html#getActionId()" class="member-name-link">getActionId()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></dt> +<dd> +<div class="block">Gets the Action ID</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#getActionId()" class="member-name-link">getActionId()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Gets the action ID</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getActiveEntries()" class="member-name-link">getActiveEntries()</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Returns the number of active, unique keys across all internal maps</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#getAnotbAction()" class="member-name-link">getAnotbAction()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Gets the AnotB action</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getAprioriError(int,long)" class="member-name-link">getAprioriError(int, long)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns the estimated <i>a priori</i> error given the maxMapSize for the sketch and the + estimatedTotalStreamWeight.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getAprioriError(int,long)" class="member-name-link">getAprioriError(int, long)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns the estimated <i>a priori</i> error given the maxMapSize for the sketch and the + estimatedTotalStreamWeight.</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getAverageSketchMemoryPerKey()" class="member-name-link">getAverageSketchMemoryPerKey()</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Returns the average memory storage per key that is dedicated to sketching the unique counts.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#getBitsUsed()" class="member-name-link">getBitsUsed()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns the number of bits in the BloomFilter that are set to 1.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getBoundaries()" class="member-name-link">getBoundaries()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Gets an ordered array of boundaries that sequentially define the upper and lower boundaries of partitions.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#getBytes()" class="member-name-link">getBytes()</a> - Method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">Gets the item size in bytes.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getC()" class="member-name-link">getC()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns the expected number of samples returned upon a call to + getResult().</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#getCapacity()" class="member-name-link">getCapacity()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns the total number of bits in the BloomFilter.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#getCaseDescription()" class="member-name-link">getCaseDescription()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Gets the case description</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D)" class="member-name-link">getCDF(double[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getCDF(double%5B%5D)" class="member-name-link">getCDF(double[])</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF), which is the + cumulative analog of the PMF, of the input stream given a set of split points.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D)" class="member-name-link">getCDF(float[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(float[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(float[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(float[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(float[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getCDF(long%5B%5D)" class="member-name-link">getCDF(long[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(long[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(long[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(long[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D)" class="member-name-link">getCDF(T[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(T[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(T[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(T[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF(T[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Returns the concrete class of type T</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getClassOfT()" class="member-name-link">getClassOfT()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#getCompactBytes()" class="member-name-link">getCompactBytes()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getCompactBytes()" class="member-name-link">getCompactBytes()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the number of storage bytes required for this Sketch if its current state were + compacted.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#getCompactBytes()" class="member-name-link">getCompactBytes()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getCompactSerialiedSizeBytes(int,long)" class="member-name-link">getCompactSerialiedSizeBytes(int, long)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns the number of bytes a DoublesSketch would require to store in compact form + given <i>k</i> and <i>n</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getCompactSerializationBytes()" class="member-name-link">getCompactSerializationBytes()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getCompactSerializationBytes()" class="member-name-link">getCompactSerializationBytes()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getCompactSketchMaxBytes(int)" class="member-name-link">getCompactSketchMaxBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured + log_base2 of the number of nominal entries, which is a power of 2.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getCompactSketchMaxBytes(int)" class="member-name-link">getCompactSketchMaxBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured + log_base2 of the number of nominal entries, which is a power of 2.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getComparator()" class="member-name-link">getComparator()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getComparator()" class="member-name-link">getComparator()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getComparator()" class="member-name-link">getComparator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Gets the Comparator for this generic type.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getComparator()" class="member-name-link">getComparator()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getComparator()" class="member-name-link">getComparator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Returns the Comparator of T</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getCompositeEstimate()" class="member-name-link">getCompositeEstimate()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getCompositeEstimate()" class="member-name-link">getCompositeEstimate()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getCount()" class="member-name-link">getCount()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong(long)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/CompactSketch.html#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong(long)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong(long)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong(long)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getCumulativeWeight()" class="member-name-link">getCumulativeWeight()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns the cumulative weight of items processed by the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getCumulativeWeights()" class="member-name-link">getCumulativeWeights()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getCumulativeWeights()" class="member-name-link">getCumulativeWeights()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getCumulativeWeights()" class="member-name-link">getCumulativeWeights()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getCumulativeWeights()" class="member-name-link">getCumulativeWeights()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedView.html#getCumulativeWeights()" class="member-name-link">getCumulativeWeights()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></dt> +<dd> +<div class="block">Returns the array of cumulative weights from the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getCurrentBytes()" class="member-name-link">getCurrentBytes()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the number of storage bytes required for this sketch in its current state.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#getCurrentBytes()" class="member-name-link">getCurrentBytes()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Returns the number of storage bytes required for this union in its current state.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html#getCurrentBytes()" class="member-name-link">getCurrentBytes()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getCurrentBytes()" class="member-name-link">getCurrentBytes()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">For compact sketches this is the same as getMaxBytes().</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#getCurrentCapacity()" class="member-name-link">getCurrentCapacity()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Get current capacity</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getCurrentCompactSerializedSizeBytes()" class="member-name-link">getCurrentCompactSerializedSizeBytes()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns the current number of bytes this sketch would require to store in the compact Memory Format.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getCurrentMapCapacity()" class="member-name-link">getCurrentMapCapacity()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns the current number of counters the sketch is configured to support.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getCurrentMapCapacity()" class="member-name-link">getCurrentMapCapacity()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns the current number of counters the sketch is configured to support.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getCurrentUpdatableSerializedSizeBytes()" class="member-name-link">getCurrentUpdatableSerializedSizeBytes()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns the current number of bytes this sketch would require to store in the updatable Memory Format.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getDoubleBE(byte%5B%5D,int)" class="member-name-link">getDoubleBE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>double</i> from the given byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getDoubleLE(byte%5B%5D,int)" class="member-name-link">getDoubleLE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>double</i> from the given byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#getEffectiveK()" class="member-name-link">getEffectiveK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns the effective <i>k</i> of this Union.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getEffectiveK()" class="member-name-link">getEffectiveK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Returns the effective <i>k</i> of this Union.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getEpsilon(int)" class="member-name-link">getEpsilon(int)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns epsilon used to compute <i>a priori</i> error.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getEpsilon(int)" class="member-name-link">getEpsilon(int)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns epsilon used to compute <i>a priori</i> error.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Returns the best estimate of the cardinality of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></dt> +<dd> +<div class="block">Returns the best estimate of the cardinality of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/SampleSubsetSummary.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Gets the unique count estimate.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getEstimate()" class="member-name-link">getEstimate()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getEstimate(byte%5B%5D)" class="member-name-link">getEstimate(byte[])</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Retrieves the current estimate of unique count for a given key.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getEstimate(int)" class="member-name-link">getEstimate(int)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the estimate of the true distinct population of subset tuples represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getEstimate(long)" class="member-name-link">getEstimate(long)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Gets the estimate of the frequency of the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getEstimate(org.apache.datasketches.memory.Memory)" class="member-name-link">getEstimate(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Gets the unique count estimate from a valid memory image of a Sketch</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getEstimate(T)" class="member-name-link">getEstimate(T)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Gets the estimate of the frequency of the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html#getEstimateOfA(long,double)" class="member-name-link">getEstimateOfA(long, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></dt> +<dd> +<div class="block">Return the estimate of A.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html#getEstimateOfB(long,double)" class="member-name-link">getEstimateOfB(long, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></dt> +<dd> +<div class="block">Return the estimate of B.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html#getEstimateOfBoverA(long,long)" class="member-name-link">getEstimateOfBoverA(long, long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></dt> +<dd> +<div class="block">Return the estimate of b over a</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA(Sketch, Sketch)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></dt> +<dd> +<div class="block">Gets the estimate for B over A</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA(Sketch<S>, Sketch)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></dt> +<dd> +<div class="block">Gets the estimate for B over A</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getEstimateOfBoverA(Sketch<S>, Sketch<S>)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></dt> +<dd> +<div class="block">Gets the estimate for B over A</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#getFamily()" class="member-name-link">getFamily()</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html#getFamily()" class="member-name-link">getFamily()</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></dt> +<dd> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html#getFamily()" class="member-name-link">getFamily()</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></dt> +<dd> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#getFamily()" class="member-name-link">getFamily()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#getFamily()" class="member-name-link">getFamily()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#getFamily()" class="member-name-link">getFamily()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#getFamily()" class="member-name-link">getFamily()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Gets the Family of this SetOperation</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getFamily()" class="member-name-link">getFamily()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the Family that this sketch belongs to</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#getFamily()" class="member-name-link">getFamily()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getFamily()" class="member-name-link">getFamily()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns the Family</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#getFamilyName()" class="member-name-link">getFamilyName()</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns the name for this family</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#getFillPercentage()" class="member-name-link">getFillPercentage()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns the percentage of all bits in the BloomFilter set to 1.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getFloatBE(byte%5B%5D,int)" class="member-name-link">getFloatBE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>float</i> from the given byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getFloatLE(byte%5B%5D,int)" class="member-name-link">getFloatLE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>float</i> from the given byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getFraction()" class="member-name-link">getFraction()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems(long, ErrorType)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems(long, ErrorType)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems(ErrorType)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems(ErrorType)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/PostProcessor.html#getGroupCount()" class="member-name-link">getGroupCount()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></dt> +<dd> +<div class="block">Returns the number of groups in the final sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/PostProcessor.html#getGroupList(int%5B%5D,int,int)" class="member-name-link">getGroupList(int[], int, int)</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></dt> +<dd> +<div class="block">Return the most frequent Groups associated with Primary Keys based on the size of the groups.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/TupleSketchIterator.html#getHash()" class="member-name-link">getHash()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a></dt> +<dd> +<div class="block">Gets the hash from the current entry in the sketch, which is a hash + of the original key passed to update().</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getHeader()" class="member-name-link">getHeader()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#getHighRankAccuracy()" class="member-name-link">getHighRankAccuracy()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">Gets the builder configured High Rank Accuracy.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getHighRankAccuracyMode()" class="member-name-link">getHighRankAccuracyMode()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#getId()" class="member-name-link">getId()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Gets the case ID</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#getID()" class="member-name-link">getID()</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns the byte ID for this family</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getInstance(java.lang.Class,int,java.util.Comparator)" class="member-name-link">getInstance(Class<T>, int, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Obtains a new instance of an ItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getInstance(java.lang.Class,int,java.util.Comparator)" class="member-name-link">getInstance(Class<T>, int, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Create an instance of ItemsUnion</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getInstance(java.lang.Class,java.util.Comparator)" class="member-name-link">getInstance(Class<T>, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Obtains a new instance of an ItemsSketch using the DEFAULT_K.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getInstance(java.lang.Class,java.util.Comparator)" class="member-name-link">getInstance(Class<T>, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Create an instance of ItemsUnion with the default k</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance(Class<T>, Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Heapifies the given srcMem, which must be a Memory image of a ItemsSketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance(Class<T>, Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Heapify the given srcMem into a Union object.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getInstance(java.lang.String)" class="member-name-link">getInstance(String)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns a sketch instance of this class from the given String, + which must be a String representation of this sketch class.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getInstance(org.apache.datasketches.memory.Memory)" class="member-name-link">getInstance(Memory)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getInstance(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance(Memory, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getInstance(org.apache.datasketches.quantiles.ItemsSketch)" class="member-name-link">getInstance(ItemsSketch<T>)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Create an instance of ItemsUnion based on ItemsSketch</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getIntBE(byte%5B%5D,int)" class="member-name-link">getIntBE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>int</i> from the given byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#getIntersectAction()" class="member-name-link">getIntersectAction()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Gets the intersect action</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getIntLE(byte%5B%5D,int)" class="member-name-link">getIntLE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>int</i> from the given byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#getItem()" class="member-name-link">getItem()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#getItem()" class="member-name-link">getItem()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html#getItem()" class="member-name-link">getItem()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></dt> +<dd> +<div class="block">Accesses the iterator's current object</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></dt> +<dd> +<div class="block">Gets the current configured <i>k</i></div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#getK()" class="member-name-link">getK()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">Gets the builder configured k.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns the configured maximum sample size.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the + reservoir.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the reservoir.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the + sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getK()" class="member-name-link">getK()</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html#getKey()" class="member-name-link">getKey()</a> - Method in interface org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></dt> +<dd> +<div class="block">Gets a key from the current entry in the sketch, which is a hash + of the original key passed to update().</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getKeyMemoryUsageBytes()" class="member-name-link">getKeyMemoryUsageBytes()</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Returns total bytes used for key storage</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon(double, boolean)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ClassicUtil.html#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon(double, boolean)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ClassicUtil.html" title="class in org.apache.datasketches.quantiles">ClassicUtil</a></dt> +<dd> +<div class="block">Used by Classic Quantiles.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon(double, boolean)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon(double, boolean)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getLgConfigK()" class="member-name-link">getLgConfigK()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getLgConfigK()" class="member-name-link">getLgConfigK()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Gets the effective <i>lgConfigK</i> for the union operator, which may be less than + <i>lgMaxK</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#getLgK()" class="member-name-link">getLgK()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return the parameter LgK.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html#getLgK()" class="member-name-link">getLgK()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></dt> +<dd> +<div class="block">Returns the current value of Log_base2 of K.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html#getLgK()" class="member-name-link">getLgK()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></dt> +<dd> +<div class="block">Returns the configured Log_base2 of K of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#getLgK()" class="member-name-link">getLgK()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Get log_base2 of Nominal Entries</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#getLgNominalEntries()" class="member-name-link">getLgNominalEntries()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Returns Log-base 2 Nominal Entries</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getLgNominalEntries()" class="member-name-link">getLgNominalEntries()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns Log-base 2 Nominal Entries</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#getLgNomLongs()" class="member-name-link">getLgNomLongs()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Gets the Log base 2 of the configured nominal entries</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getLocalLgNominalEntries()" class="member-name-link">getLocalLgNominalEntries()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns Log-base 2 Nominal Entries for the concurrent local sketch</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getLongBE(byte%5B%5D,int)" class="member-name-link">getLongBE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>long</i> from the source byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getLongLE(byte%5B%5D,int)" class="member-name-link">getLongLE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>long</i> from the given byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getLowerBound()" class="member-name-link">getLowerBound()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#getLowerBound()" class="member-name-link">getLowerBound()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#getLowerBound()" class="member-name-link">getLowerBound()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/SampleSubsetSummary.html#getLowerBound()" class="member-name-link">getLowerBound()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getLowerBound(byte%5B%5D)" class="member-name-link">getLowerBound(byte[])</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Returns the lower bound cardinality with respect to <a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getEstimate(byte%5B%5D)"><code>UniqueCountMap.getEstimate(byte[])</code></a> associated + with the given key.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#getLowerBound(int)" class="member-name-link">getLowerBound(int)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html#getLowerBound(int)" class="member-name-link">getLowerBound(int)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></dt> +<dd> +<div class="block">Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getLowerBound(int)" class="member-name-link">getLowerBound(int)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getLowerBound(int)" class="member-name-link">getLowerBound(int)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getLowerBound(int)" class="member-name-link">getLowerBound(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getLowerBound(int)" class="member-name-link">getLowerBound(int)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getLowerBound(int)" class="member-name-link">getLowerBound(int)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getLowerBound(int,int)" class="member-name-link">getLowerBound(int, int)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the estimate of the lower bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getLowerBound(int,org.apache.datasketches.memory.Memory)" class="member-name-link">getLowerBound(int, Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Gets the approximate lower error bound from a valid memory image of a Sketch + given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getLowerBound(long)" class="member-name-link">getLowerBound(long)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Gets the guaranteed lower bound frequency of the given item, which can never be + negative.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BinomialBoundsN.html#getLowerBound(long,double,int,boolean)" class="member-name-link">getLowerBound(long, double, int, boolean)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BinomialBoundsN.html" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a></dt> +<dd> +<div class="block">Returns the approximate lower bound value</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getLowerBound(T)" class="member-name-link">getLowerBound(T)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Gets the guaranteed lower bound frequency of the given item, which can never be + negative.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html#getLowerBoundForBoverA(long,long,double)" class="member-name-link">getLowerBoundForBoverA(long, long, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></dt> +<dd> +<div class="block">Return the approximate lower bound based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA(Sketch, Sketch)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></dt> +<dd> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA(Sketch<S>, Sketch)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></dt> +<dd> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getLowerBoundForBoverA(Sketch<S>, Sketch<S>)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></dt> +<dd> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#getMaxAnotBResultBytes(int)" class="member-name-link">getMaxAnotBResultBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Returns the maximum number of bytes for the returned CompactSketch, given the + value of nomEntries of the first sketch A of AnotB.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getMaxAnotBResultBytes(int)" class="member-name-link">getMaxAnotBResultBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#getMaxAnotBResultBytes(int)"><code>SetOperation.getMaxAnotBResultBytes(int)</code></a>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html#getMaxBytes()" class="member-name-link">getMaxBytes()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getMaxBytes()" class="member-name-link">getMaxBytes()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#getMaxBytes(int,int)" class="member-name-link">getMaxBytes(int, int)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getMaxCompactSketchBytes(int)" class="member-name-link">getMaxCompactSketchBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given + number of actual entries.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getMaxCompactSketchBytes(int)" class="member-name-link">getMaxCompactSketchBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given + number of actual entries.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getMaxConcurrencyError()" class="member-name-link">getMaxConcurrencyError()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Gets the Maximum Concurrency Error</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getMaximumError()" class="member-name-link">getMaximumError()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getMaximumError()" class="member-name-link">getMaximumError()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getMaximumMapCapacity()" class="member-name-link">getMaximumMapCapacity()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns the maximum number of counters the sketch is configured to support.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getMaximumMapCapacity()" class="member-name-link">getMaximumMapCapacity()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns the maximum number of counters the sketch is configured to support.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#getMaxIntersectionBytes(int)" class="member-name-link">getMaxIntersectionBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Returns the maximum required storage bytes given a nomEntries parameter for Intersection + operations</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getMaxIntersectionBytes(int)" class="member-name-link">getMaxIntersectionBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Returns the maximum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getMaxItem()" class="member-name-link">getMaxItem()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#getMaxK()" class="member-name-link">getMaxK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns the configured <i>maxK</i> of this Union.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html#getMaxK()" class="member-name-link">getMaxK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></dt> +<dd> +<div class="block">Gets the current configured <i>maxK</i></div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getMaxK()" class="member-name-link">getMaxK()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Returns the configured <i>maxK</i> of this Union.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#getMaxK()" class="member-name-link">getMaxK()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Returns the maximum allowed reservoir capacity in this union.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#getMaxK()" class="member-name-link">getMaxK()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Returns the maximum allowed reservoir capacity in this union.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getMaxNumLocalThreads()" class="member-name-link">getMaxNumLocalThreads()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Gets the Maximum Number of Local Threads.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getMaxPartitions()" class="member-name-link">getMaxPartitions()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getMaxPartitions()" class="member-name-link">getMaxPartitions()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html#getMaxPartitions()" class="member-name-link">getMaxPartitions()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></dt> +<dd> +<div class="block">Gets the maximum number of partitions this sketch will support based on the configured size <i>K</i> + and the number of retained values of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#getMaxPreLongs()" class="member-name-link">getMaxPreLongs()</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns the maximum preamble size for this family in longs</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getMaxSerializationBytes(int)" class="member-name-link">getMaxSerializationBytes(int)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Returns the maximum size in bytes that this union operator can grow to given a lgK.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#getMaxSerializedBytes(int)" class="member-name-link">getMaxSerializedBytes(int)</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">The actual size of a compressed CPC sketch has a small random variance, but the following + empirically measured size should be large enough for at least 99.9 percent of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)" class="member-name-link">getMaxSerializedSizeBytes(int, long, KllSketch.SketchType, boolean)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Returns upper bound on the serialized size of a KllSketch given the following parameters.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#getMaxUnionBytes()" class="member-name-link">getMaxUnionBytes()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Returns the maximum required storage bytes for this union.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#getMaxUnionBytes(int)" class="member-name-link">getMaxUnionBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Returns the maximum required storage bytes given a nomEntries parameter for Union operations</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getMaxUnionBytes(int)" class="member-name-link">getMaxUnionBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)" class="member-name-link">getMaxUpdatableSerializationBytes(int, TgtHllType)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Returns the maximum size in bytes that this sketch can grow to given lgConfigK.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getMaxUpdateSketchBytes(int)" class="member-name-link">getMaxUpdateSketchBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the maximum number of storage bytes required for an UpdateSketch with the given + number of nominal entries (power of 2).</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getMaxUpdateSketchBytes(int)" class="member-name-link">getMaxUpdateSketchBytes(int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getMaxValue()" class="member-name-link">getMaxValue()</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#getMemoryRequestServer()" class="member-name-link">getMemoryRequestServer()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Returns the MemoryRequestServer</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getMemoryRequestServer()" class="member-name-link">getMemoryRequestServer()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns the MemoryRequestServer</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getMemoryUsageBytes()" class="member-name-link">getMemoryUsageBytes()</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Returns total bytes used by all internal maps</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Returns the minimum item of the stream.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getMinItem()" class="member-name-link">getMinItem()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html#getMinPartitionSizeItems()" class="member-name-link">getMinPartitionSizeItems()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></dt> +<dd> +<div class="block">Gets the minimum partition size in items this sketch will support based on the configured size <i>K</i> of this + sketch and the number of retained values of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#getMinPreLongs()" class="member-name-link">getMinPreLongs()</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns the minimum preamble size for this family in longs</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getMinValue()" class="member-name-link">getMinValue()</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Gets the length of the input stream offered to the underlying sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#getN()" class="member-name-link">getN()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html#getN()" class="member-name-link">getN()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></dt> +<dd> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedView.html#getN()" class="member-name-link">getN()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></dt> +<dd> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt> +<dd> +<div class="block">Gets the total count of all items presented to the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns the number of items processed by the sketch, regardless + of item weight.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns the number of items processed from the input stream</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns the number of items processed from the input stream</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#getN()" class="member-name-link">getN()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns the number of items processed from the input stream</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#getName()" class="member-name-link">getName()</a> - Method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">Get the name of the associated sketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNaturalRank()" class="member-name-link">getNaturalRank()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt> +<dd> +<div class="block">Gets the natural rank at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#getNaturalRank(double,long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNaturalRank(double, long, QuantileSearchCriteria)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">Computes the closest Natural Rank from a given Normalized Rank</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNaturalRank(QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt> +<dd> +<div class="block">Gets the natural rank at the current index (or previous index) based on the chosen search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getNaturalRanks()" class="member-name-link">getNaturalRanks()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Gets an ordered array of natural ranks of the associated array of partition boundaries utilizing + a specified search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#getNominalEntries()" class="member-name-link">getNominalEntries()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Gets the configured nominal number of entries</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#getNominalEntries()" class="member-name-link">getNominalEntries()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Get configured nominal number of entries</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNormalizedRank()" class="member-name-link">getNormalizedRank()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt> +<dd> +<div class="block">Gets the normalized rank at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNormalizedRank(QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt> +<dd> +<div class="block">Gets the normalized rank at the current index (or previous index) + based on the chosen search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError(boolean)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError(boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError(boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError(boolean)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError(boolean)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError(int, boolean)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Gets the normalized rank error given k and pmf.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ClassicUtil.html#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError(int, boolean)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ClassicUtil.html" title="class in org.apache.datasketches.quantiles">ClassicUtil</a></dt> +<dd> +<div class="block">Used by Classic Quantiles.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError(int, boolean)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Gets the normalized rank error given k and pmf.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError(int, boolean)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Gets the normalized rank error given k and pmf.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getNormalizedRanks()" class="member-name-link">getNormalizedRanks()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Gets an ordered array of normalized ranks of the associated array of partition boundaries utilizing + a specified search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getNumActiveItems()" class="member-name-link">getNumActiveItems()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getNumActiveItems()" class="member-name-link">getNumActiveItems()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getNumDeltaItems()" class="member-name-link">getNumDeltaItems()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Gets the number of items to be included for each partition as an array.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#getNumHashes()" class="member-name-link">getNumHashes()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns the configured number of hash functions for this BloomFilter</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getNumPartitions()" class="member-name-link">getNumPartitions()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Gets the number of partitions</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getNumPoolThreads()" class="member-name-link">getNumPoolThreads()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Gets the number of background pool threads used for propagation in the concurrent sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedView.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></dt> +<dd> +<div class="block">Gets the number of quantiles retained by this sorted view.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getNumRetained()" class="member-name-link">getNumRetained()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#getNumSamples()" class="member-name-link">getNumSamples()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns the current number of items in the reservoir, which may be smaller than the + reservoir capacity.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#getNumSamples()" class="member-name-link">getNumSamples()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns the current number of items in the reservoir, which may be smaller than the reservoir + capacity.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#getNumSamples()" class="member-name-link">getNumSamples()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt> +<dd> +<div class="block">Returns the length Copies items and weights from the sketch, if necessary, and returns the + length of + any + resulting array.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#getNumSamples()" class="member-name-link">getNumSamples()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns the current number of items in the sketch, which may be smaller than the + sketch capacity.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getNumValues()" class="member-name-link">getNumValues()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/DeserializeResult.html#getObject()" class="member-name-link">getObject()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#getP()" class="member-name-link">getP()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Returns the pre-sampling probability <i>p</i></div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getP()" class="member-name-link">getP()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns the pre-sampling probability <i>p</i></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)" class="member-name-link">getPartitionBoundariesFromNumParts(int)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></dt> +<dd> +<div class="block">This method returns an instance of + <a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></dt> +<dd> +<div class="block">This method returns an instance of + <a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)" class="member-name-link">getPartitionBoundariesFromPartSize(long)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></dt> +<dd> +<div class="block">This method returns an instance of + <a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></dt> +<dd> +<div class="block">This method returns an instance of + <a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D)" class="member-name-link">getPMF(double[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getPMF(double%5B%5D)" class="member-name-link">getPMF(double[])</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + given a set of split points.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D)" class="member-name-link">getPMF(float[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(float[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(float[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(float[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(float[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getPMF(long%5B%5D)" class="member-name-link">getPMF(long[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(long[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(long[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(long[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D)" class="member-name-link">getPMF(T[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(T[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(T[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(T[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF(T[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#getPostProcessor()" class="member-name-link">getPostProcessor()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#getPostProcessor(org.apache.datasketches.fdt.Group,char)" class="member-name-link">getPostProcessor(Group, char)</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#getPreInts()" class="member-name-link">getPreInts()</a> - Method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">gets the Preamble Integers for this Structure.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getPrimaryKey()" class="member-name-link">getPrimaryKey()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getPropagateOrderedCompact()" class="member-name-link">getPropagateOrderedCompact()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Gets the Propagate Ordered Compact flag used with concurrent sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketchIterator.html" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketchIterator.html" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></dt> +<dd> +<div class="block">Gets the quantile at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></dt> +<dd> +<div class="block">Gets the quantile at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></dt> +<dd> +<div class="block">Gets the quantile at the current index + This is equivalent to <i>getQuantile(INCLUSIVE)</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></dt> +<dd> +<div class="block">Gets the quantile at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></dt> +<dd> +<div class="block">Gets the double quantile at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></dt> +<dd> +<div class="block">Gets the float quantile at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></dt> +<dd> +<div class="block">Gets the generic quantile at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></dt> +<dd> +<div class="block">Gets the long quantile at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchIterator.html#getQuantile()" class="member-name-link">getQuantile()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantile(double)" class="member-name-link">getQuantile(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantile(double)" class="member-name-link">getQuantile(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantile(double)" class="member-name-link">getQuantile(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantile(double)" class="member-name-link">getQuantile(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getQuantile(double)" class="member-name-link">getQuantile(double)</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Compute approximate quantile value corresponding to the given normalized rank</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html#getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile(QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></dt> +<dd> +<div class="block">Gets the quantile at the current index (or previous index) + based on the chosen search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound(double)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getQuantileLowerBound(double,int)" class="member-name-link">getQuantileLowerBound(double, int)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Returns the full array of quantiles.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#getQuantiles()" class="member-name-link">getQuantiles()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles(double[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles(double[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles(double[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles(double[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> +<div class="block">Gets an array of quantiles corresponding to the given array of ranks.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound(double)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getQuantileUpperBound(double,int)" class="member-name-link">getQuantileUpperBound(double, int)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/partitions/SketchFillRequest.html#getRange(T,T,org.apache.datasketches.partitions.BoundsRule)" class="member-name-link">getRange(T, T, BoundsRule)</a> - Method in interface org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a></dt> +<dd> +<div class="block">This is a callback request to the data source to fill a quantiles sketch + with a range of data between upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRank(double)" class="member-name-link">getRank(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getRank(double)" class="member-name-link">getRank(double)</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Compute approximate normalized rank of the given value.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(double, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(double, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getRank(float)" class="member-name-link">getRank(float)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(float, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(float, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(float, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(float, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(float, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getRank(long)" class="member-name-link">getRank(long)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(long, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(long, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(long, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(long, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRank(T)" class="member-name-link">getRank(T)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(T quantile, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(T, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(T, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(T, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(T, QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank(T, QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getRankLowerBound(double)" class="member-name-link">getRankLowerBound(double)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getRankLowerBound(double,int)" class="member-name-link">getRankLowerBound(double, int)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D)" class="member-name-link">getRanks(double[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(double[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(double[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D)" class="member-name-link">getRanks(float[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(float[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(float[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(float[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getRanks(long%5B%5D)" class="member-name-link">getRanks(long[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(long[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(long[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D)" class="member-name-link">getRanks(T[])</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(T[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(T[], QuantileSearchCriteria)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks(T[], QuantileSearchCriteria)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getRankUpperBound(double)" class="member-name-link">getRankUpperBound(double)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getRankUpperBound(double,int)" class="member-name-link">getRankUpperBound(double, int)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getRelErr(boolean,boolean,int,int)" class="member-name-link">getRelErr(boolean, boolean, int, int)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Gets the current (approximate) Relative Error (RE) asymptotic values given several + parameters.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#getReqDebug()" class="member-name-link">getReqDebug()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">Gets the builder configured ReqDebug</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#getResizeFactor()" class="member-name-link">getResizeFactor()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Returns the Resize Factor</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#getResizeFactor()" class="member-name-link">getResizeFactor()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Returns the configured ResizeFactor</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getResizeFactor()" class="member-name-link">getResizeFactor()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns the Resize Factor</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#getResizeFactor()" class="member-name-link">getResizeFactor()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Gets the configured resize factor</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#getResizeFactor()" class="member-name-link">getResizeFactor()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Get configured resize factor</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></dt> +<dd> +<div class="block">Returns the result of union operations as a CPC sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Return the result of this union operator as an HLL_4 sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Gets the result of this Union operation as a copy of the internal state.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns a copy of the current sample.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Returns a sketch representing the current state of the union.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Returns a sketch representing the current state of the union.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Gets the varopt sketch resulting from the union of any input sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></dt> +<dd> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></dt> +<dd> +<div class="block">Gets the internal set as an on-heap compact sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Gets the internal set as an unordered CompactSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#getResult()" class="member-name-link">getResult()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#getResult(boolean)" class="member-name-link">getResult(boolean)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="org/apache/datasketches/theta/AnotB.html#setA(org.apache.datasketches.theta.Sketch)"><code>AnotB.setA(Sketch)</code></a> and (<a href="org/apache/datasketches/theta/AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(Sketch)</code></a> or + <a href="org/apache/datasketches/theta/AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#getResult(boolean)" class="member-name-link">getResult(boolean)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="org/apache/datasketches/tuple/AnotB.html#setA(org.apache.datasketches.tuple.Sketch)"><code>AnotB.setA(Sketch)</code></a> and (<a href="org/apache/datasketches/tuple/AnotB.html#notB(org.apache.datasketches.tuple.Sketch)"><code>AnotB.notB(Sketch)</code></a> or + <a href="org/apache/datasketches/tuple/AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#getResult(boolean)" class="member-name-link">getResult(boolean)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#getResult(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult(boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Gets the result of this operation as a CompactSketch in the given dstMem.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#getResult(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult(boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Gets the result of this operation as a CompactSketch of the chosen form.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#getResult(boolean,org.apache.datasketches.memory.WritableMemory,boolean)" class="member-name-link">getResult(boolean, WritableMemory, boolean)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="org/apache/datasketches/theta/AnotB.html#setA(org.apache.datasketches.theta.Sketch)"><code>AnotB.setA(Sketch)</code></a> and (<a href="org/apache/datasketches/theta/AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(Sketch)</code></a> or + <a href="org/apache/datasketches/theta/AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#getResult(int%5B%5D,int,int,char)" class="member-name-link">getResult(int[], int, int, char)</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> +<div class="block">Returns an ordered List of Groups of the most frequent distinct population of subset tuples + represented by the count of entries of each group.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getResult(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">getResult(TgtHllType)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Return the result of this union operator with the specified <a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult(WritableMemory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Places the result of this Union into the provided memory as an UpdateDoublesSketch, + which enables further update operations on the resulting sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></dt> +<dd> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></dt> +<dd> +<div class="block">Gets the result of stateful intersections so far.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult(WritableMemory)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#getResultAndReset()" class="member-name-link">getResultAndReset()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#getResultAndReset()" class="member-name-link">getResultAndReset()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Gets the result of this Union operation (without a copy) and resets this Union to the + virgin state.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getRetainedEntries()" class="member-name-link">getRetainedEntries()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the number of valid entries that have been retained by the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getRetainedEntries()" class="member-name-link">getRetainedEntries()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/CompactSketch.html#getRetainedEntries()" class="member-name-link">getRetainedEntries()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#getRetainedEntries()" class="member-name-link">getRetainedEntries()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getRetainedEntries()" class="member-name-link">getRetainedEntries()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getRetainedEntries(boolean)" class="member-name-link">getRetainedEntries(boolean)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the number of entries that have been retained by the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#getRF(int)" class="member-name-link">getRF(int)</a> - Static method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Returns the Resize Factor given the Log-base 2 of the Resize Factor</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#getRowHeader()" class="member-name-link">getRowHeader()</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#getRowHeader()" class="member-name-link">getRowHeader()</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getRse()" class="member-name-link">getRse()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getRSE(int,double,boolean,long)" class="member-name-link">getRSE(int, double, boolean, long)</a> - Static method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> +<div class="block">Returns an a priori estimate of relative standard error (RSE, expressed as a number in [0,1]).</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#getSamples()" class="member-name-link">getSamples()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a copy of the items in the reservoir, or null if empty.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#getSamples()" class="member-name-link">getSamples()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns a copy of the items in the reservoir.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#getSamples(java.lang.Class)" class="member-name-link">getSamples(Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a copy of the items in the reservoir as members of Class <em>clazz</em>, or null + if empty.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#getSamplingProbability()" class="member-name-link">getSamplingProbability()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Gets the configured sampling probability</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#getSamplingProbability()" class="member-name-link">getSamplingProbability()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Get configured sampling probability</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html#getSearchCriteria()" class="member-name-link">getSearchCriteria()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></dt> +<dd> +<div class="block">Gets the search criteria specified for the source sketch</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#getSeed()" class="member-name-link">getSeed()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns the hash seed for this BloomFilter.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#getSeed()" class="member-name-link">getSeed()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Returns the seed</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getSeed()" class="member-name-link">getSeed()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Returns the seed</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getSerializationVersion()" class="member-name-link">getSerializationVersion()</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Returns the current serialization version.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)" class="member-name-link">getSerializationVersion(Memory)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Returns the current serialization version of the given Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)" class="member-name-link">getSerializationVersion(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns the serialization version from the given Memory</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getSerializationVersion(org.apache.datasketches.memory.Memory)" class="member-name-link">getSerializationVersion(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#getSerializedFilterSize(long)" class="member-name-link">getSerializedFilterSize(long)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Returns the minimum memory size, in bytes, needed for a serialized BloomFilter with the given number of bits.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#getSerializedFilterSizeByAccuracy(long,double)" class="member-name-link">getSerializedFilterSizeByAccuracy(long, double)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Returns the minimum memory size, in bytes, needed for a serialized BloomFilter with an optimal number of bits + and hash functions for the given inputs.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#getSerializedSize(long)" class="member-name-link">getSerializedSize(long)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns the serialized length of a non-empty BloomFilter of the given size, in bytes</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns the length of this BloomFilter when serialized, in bytes</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Returns the current number of bytes this Sketch would require if serialized in compact form.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getSerializedSizeBytes(ArrayOfItemsSerDe<? super T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns the size of a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">getSerializedSizeBytes(ArrayOfItemsSerDe<? super T>, Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns the length of a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#getSerVer()" class="member-name-link">getSerVer()</a> - Method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">gets the Serialization Version for this Structure.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getShortBE(byte%5B%5D,int)" class="member-name-link">getShortBE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>short</i> from the given byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#getShortLE(byte%5B%5D,int)" class="member-name-link">getShortLE(byte[], int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Get a <i>short</i> from the given byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/DeserializeResult.html#getSize()" class="member-name-link">getSize()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#getSketchSamples()" class="member-name-link">getSketchSamples()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Gets a result iterator object.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#getSketchStructure(int,int)" class="member-name-link">getSketchStructure(int, int)</a> - Static method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">gets the SketchStructure given preInts and serVer.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.html#getSketchType(org.apache.datasketches.memory.Memory)" class="member-name-link">getSketchType(Memory)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></dt> +<dd> +<div class="block">Gets the sketch type byte from the given Memory image</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets the sorted view of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets the sorted view of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets the sorted view of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets the sorted view of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#getSortedView()" class="member-name-link">getSortedView()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#getStartingCapacity(int,int)" class="member-name-link">getStartingCapacity(int, int)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Gets the starting capacity of a new sketch given the Nominal Entries and the log Resize Factor.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getStorageBytes()" class="member-name-link">getStorageBytes()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns the number of bytes required to store this sketch as an array of bytes.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getStreamLength()" class="member-name-link">getStreamLength()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns the sum of the frequencies in the stream seen so far by the sketch</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getStreamLength()" class="member-name-link">getStreamLength()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns the sum of the frequencies (weights or counts) in the stream seen so far by the sketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/TupleSketchIterator.html#getSummary()" class="member-name-link">getSummary()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a></dt> +<dd> +<div class="block">Gets a Summary object from the current entry in the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getSummaryFactory()" class="member-name-link">getSummaryFactory()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the Summary Factory class of type S</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getTgtHllType()" class="member-name-link">getTgtHllType()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getTgtHllType()" class="member-name-link">getTgtHllType()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getTheta()" class="member-name-link">getTheta()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Gets the value of theta as a double with a value between zero and one</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getTheta()" class="member-name-link">getTheta()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Gets the value of theta as a double between zero and one</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getTheta()" class="member-name-link">getTheta()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the value of theta as a double between zero and one</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getThetaLong()" class="member-name-link">getThetaLong()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Gets the value of theta as a long</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getThetaLong()" class="member-name-link">getThetaLong()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Returns Theta as a long</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/SampleSubsetSummary.html#getTotalSketchWeight()" class="member-name-link">getTotalSketchWeight()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#getTotalWeight()" class="member-name-link">getTotalWeight()</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#getUnionAction()" class="member-name-link">getUnionAction()</a> - Method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Gets the union action</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getUpdatableSerializationBytes()" class="member-name-link">getUpdatableSerializationBytes()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getUpdatableSerializationBytes()" class="member-name-link">getUpdatableSerializationBytes()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#getUpdatableStorageBytes(int,long)" class="member-name-link">getUpdatableStorageBytes(int, long)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns the number of bytes a sketch would require to store in updatable form.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#getUpperBound()" class="member-name-link">getUpperBound()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#getUpperBound()" class="member-name-link">getUpperBound()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#getUpperBound()" class="member-name-link">getUpperBound()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/SampleSubsetSummary.html#getUpperBound()" class="member-name-link">getUpperBound()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getUpperBound(byte%5B%5D)" class="member-name-link">getUpperBound(byte[])</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Returns the upper bound cardinality with respect to <a href="org/apache/datasketches/hllmap/UniqueCountMap.html#getEstimate(byte%5B%5D)"><code>UniqueCountMap.getEstimate(byte[])</code></a> associated + with the given key.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#getUpperBound(int)" class="member-name-link">getUpperBound(int)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcWrapper.html#getUpperBound(int)" class="member-name-link">getUpperBound(int)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></dt> +<dd> +<div class="block">Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#getUpperBound(int)" class="member-name-link">getUpperBound(int)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#getUpperBound(int)" class="member-name-link">getUpperBound(int)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#getUpperBound(int)" class="member-name-link">getUpperBound(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getUpperBound(int)" class="member-name-link">getUpperBound(int)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getUpperBound(int)" class="member-name-link">getUpperBound(int)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#getUpperBound(int,int)" class="member-name-link">getUpperBound(int, int)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Gets the estimate of the upper bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#getUpperBound(int,org.apache.datasketches.memory.Memory)" class="member-name-link">getUpperBound(int, Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Gets the approximate upper error bound from a valid memory image of a Sketch + given the specified number of Standard Deviations.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#getUpperBound(long)" class="member-name-link">getUpperBound(long)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Gets the guaranteed upper bound frequency of the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BinomialBoundsN.html#getUpperBound(long,double,int,boolean)" class="member-name-link">getUpperBound(long, double, int, boolean)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BinomialBoundsN.html" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a></dt> +<dd> +<div class="block">Returns the approximate upper bound value</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#getUpperBound(T)" class="member-name-link">getUpperBound(T)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Gets the guaranteed upper bound frequency of the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html#getUpperBoundForBoverA(long,long,double)" class="member-name-link">getUpperBoundForBoverA(long, long, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></dt> +<dd> +<div class="block">Return the approximate upper bound based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA(Sketch, Sketch)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></dt> +<dd> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA(Sketch<S>, Sketch)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></dt> +<dd> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getUpperBoundForBoverA(Sketch<S>, Sketch<S>)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></dt> +<dd> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#getValue()" class="member-name-link">getValue()</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Returns the Resize Factor</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html#getValue()" class="member-name-link">getValue()</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html#getValue()" class="member-name-link">getValue()</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html#getValue()" class="member-name-link">getValue()</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getValues()" class="member-name-link">getValues()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html#getValues()" class="member-name-link">getValues()</a> - Method in interface org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></dt> +<dd> +<div class="block">Gets an array of values from the current entry in the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketchIterator.html#getWeight()" class="member-name-link">getWeight()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html#getWeight()" class="member-name-link">getWeight()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html#getWeight()" class="member-name-link">getWeight()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html#getWeight()" class="member-name-link">getWeight()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></dt> +<dd> +<div class="block">Gets the natural weight at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getWeight()" class="member-name-link">getWeight()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt> +<dd> +<div class="block">Gets the weight contribution of the item at the current index.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchIterator.html#getWeight()" class="member-name-link">getWeight()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html#getWeight()" class="member-name-link">getWeight()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></dt> +<dd> +<div class="block">Accesses the iterator's current weight value</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.StackElement.html#gpb" class="member-name-link">gpb</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a></dt> +<dd> +<div class="block">A reference to the relevant GenericPartitionBoundaries class</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html" class="type-name-link" title="class in org.apache.datasketches.fdt">Group</a> - Class in <a href="org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a></dt> +<dd> +<div class="block">Defines a Group from a Frequent Distinct Tuple query.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#%3Cinit%3E()" class="member-name-link">Group()</a> - Constructor for class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> +<div class="block">Construct an empty Group</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html#GT" class="member-name-link">GT</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#GT" class="member-name-link">GT</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +</dl> +<h2 class="title" id="I:H">H</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(byte%5B%5D,int,int,long)" class="member-name-link">hash(byte[], int, int, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash a portion of the given byte[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(byte%5B%5D,long)" class="member-name-link">hash(byte[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash the given byte[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(char%5B%5D,int,int,long)" class="member-name-link">hash(char[], int, int, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash a portion of the given char[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(char%5B%5D,long)" class="member-name-link">hash(char[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash the given char[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(int%5B%5D,int,int,long)" class="member-name-link">hash(int[], int, int, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash a portion of the given int[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(int%5B%5D,long)" class="member-name-link">hash(int[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash the given int[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(long%5B%5D,int,int,long)" class="member-name-link">hash(long[], int, int, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash a portion of the given long[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(long%5B%5D,long)" class="member-name-link">hash(long[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash the given long[] array.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(long,long)" class="member-name-link">hash(long, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash the given long.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/XxHash.html#hash(long,long)" class="member-name-link">hash(long, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/XxHash.html" title="class in org.apache.datasketches.hash">XxHash</a></dt> +<dd> +<div class="block">Returns a 64-bit hash.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(java.nio.ByteBuffer,long)" class="member-name-link">hash(ByteBuffer, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash the remaining bytes of the given ByteBuffer starting at position().</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html#hash(org.apache.datasketches.memory.Memory,long)" class="member-name-link">hash(Memory, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></dt> +<dd> +<div class="block">Hash the given Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/XxHash.html#hash(org.apache.datasketches.memory.Memory,long,long,long)" class="member-name-link">hash(Memory, long, long, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/XxHash.html" title="class in org.apache.datasketches.hash">XxHash</a></dt> +<dd> +<div class="block">Compute the hash of the given Memory object.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#hashArrayInsert(long%5B%5D,long%5B%5D,int,long)" class="member-name-link">hashArrayInsert(long[], long[], int, long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">Inserts the given long array into the given OADH hashTable of the target size, + ignores duplicates and counts the values inserted.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#hashCode()" class="member-name-link">hashCode()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#hashCode()" class="member-name-link">hashCode()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> +<div class="block">This hashCode is computed only from the Row.getEstimate() value.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#hashCode()" class="member-name-link">hashCode()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> +<div class="block">This hashCode is computed only from the Row.getEstimate() value.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html#hashCode()" class="member-name-link">hashCode()</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#hashInsertOnly(long%5B%5D,int,long)" class="member-name-link">hashInsertOnly(long[], int, long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for on-heap.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#hashInsertOnlyMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)" class="member-name-link">hashInsertOnlyMemory(WritableMemory, int, long, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/HashIterator.html" class="type-name-link" title="interface in org.apache.datasketches.theta">HashIterator</a> - Interface in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">This is used to iterate over the retained hash values of the Theta sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">HashOperations</a> - Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">Helper class for the common hash table methods.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#hashSearch(long%5B%5D,int,long)" class="member-name-link">hashSearch(long[], int, long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) search scheme for on-heap.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#hashSearchMemory(org.apache.datasketches.memory.Memory,int,long,int)" class="member-name-link">hashSearchMemory(Memory, int, long, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) search scheme for Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#hashSearchOrInsert(long%5B%5D,int,long)" class="member-name-link">hashSearchOrInsert(long[], int, long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for on-heap.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#hashSearchOrInsertMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)" class="member-name-link">hashSearchOrInsertMemory(WritableMemory, int, long, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash insert scheme, but inserts + values directly into a Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToBytes(byte%5B%5D,long)" class="member-name-link">hashToBytes(byte[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a byte[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToBytes(char%5B%5D,long)" class="member-name-link">hashToBytes(char[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a char[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToBytes(double,long)" class="member-name-link">hashToBytes(double, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a double and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToBytes(int%5B%5D,long)" class="member-name-link">hashToBytes(int[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash an int[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToBytes(long%5B%5D,long)" class="member-name-link">hashToBytes(long[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a long[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToBytes(long,long)" class="member-name-link">hashToBytes(long, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a long and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToBytes(java.lang.String,long)" class="member-name-link">hashToBytes(String, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a String and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToLongs(byte%5B%5D,long)" class="member-name-link">hashToLongs(byte[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a byte[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToLongs(char%5B%5D,long)" class="member-name-link">hashToLongs(char[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a char[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToLongs(double,long)" class="member-name-link">hashToLongs(double, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a double and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToLongs(int%5B%5D,long)" class="member-name-link">hashToLongs(int[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a int[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToLongs(long%5B%5D,long)" class="member-name-link">hashToLongs(long[], long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a long[] and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToLongs(long,long)" class="member-name-link">hashToLongs(long, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a long and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#hashToLongs(java.lang.String,long)" class="member-name-link">hashToLongs(String, long)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Hash a String and long seed.</div> +</dd> +<dt><a href="org/apache/datasketches/common/MemoryStatus.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in interface org.apache.datasketches.common.<a href="org/apache/datasketches/common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></dt> +<dd> +<div class="block">Returns true if this object's internal data is backed by a Memory object, + which may be on-heap or off-heap.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns whether the filter has a backing Memory object</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns true if this union's data structure is backed by Memory or WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#hasMemory()" class="member-name-link">hasMemory()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html#hasNext()" class="member-name-link">hasNext()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.VarOptItemsIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#hasResult()" class="member-name-link">hasResult()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Returns true if there is a valid intersection result available</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#hasResult()" class="member-name-link">hasResult()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Returns true if there is a valid intersection result available</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#heapify(byte%5B%5D)" class="member-name-link">heapify(byte[])</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return the given byte array as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#heapify(byte%5B%5D)" class="member-name-link">heapify(byte[])</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Heapify the given byte array, which must be a valid HllSketch image and may have data.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#heapify(byte%5B%5D)" class="member-name-link">heapify(byte[])</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Construct a union operator populated with the given byte array image of an HllSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#heapify(byte%5B%5D,long)" class="member-name-link">heapify(byte[], long)</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return the given byte array as a CpcSketch on the Java heap.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return the given Memory as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Reads a serialized image of a BloomFilter from the provided Memory</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Heapify the given Memory, which must be a valid HllSketch image and may have data.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Construct a union operator populated with the given Memory image of an HllSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given memory + image of a sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></dt> +<dd> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> +<div class="block">Returns an ReqSketch on the heap from a Memory image of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns a sketch instance of this class from the given srcMem, which must be a Memory + representation of this sketch class.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Instantiates a Union from Memory</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Deserialize TDigest from a given memory.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Heapify takes the SetOperations image in Memory and instantiates an on-heap + SetOperation using the + <a href="./resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#heapify(org.apache.datasketches.memory.Memory,boolean)" class="member-name-link">heapify(Memory, boolean)</a> - Static method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Deserialize TDigest from a given memory.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return the given Memory as a CpcSketch on the Java heap.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Heapify takes the SetOperation image in Memory and instantiates an on-heap + SetOperation using the given expectedSeed.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify(Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify(Memory, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify(Memory, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify(Memory, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Instantiates a Union from Memory</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify(Memory, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify(Memory, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Instantiates a Union from Memory</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#heapify(org.apache.datasketches.quantiles.DoublesSketch)" class="member-name-link">heapify(DoublesSketch)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifyCompactSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyCompactSketch(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifyCompactSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyCompactSketch(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifySetOperation(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySetOperation(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifySetOperation(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySetOperation(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySketch(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#heapifySketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySketch(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySketch(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#heapifySketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySketch(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer)" class="member-name-link">heapifySketch(Memory, SummaryDeserializer<S>)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></dt> +<dd> +<div class="block">Instantiate a Sketch from a given Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary(Memory)</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary(Memory)</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary(Memory)</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary(Memory)</a> - Method in interface org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a></dt> +<dd> +<div class="block">This is to create an instance of a Summary given a serialized representation.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#heapifyUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUnion(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#heapifyUnion(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUnion(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUpdatableSketch(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUpdatableSketch(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">heapifyUpdatableSketch(Memory, SummaryDeserializer<S>, SummaryFactory<S>)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></dt> +<dd> +<div class="block">Instantiate UpdatableSketch from a given Memory</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifyUpdateSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUpdateSketch(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#heapifyUpdateSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUpdateSketch(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#HLL" class="member-name-link">HLL</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The HLL family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/TgtHllType.html#HLL_4" class="member-name-link">HLL_4</a> - Enum constant in enum class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></dt> +<dd> +<div class="block">An HLL sketch with a bin size of 4 bits</div> +</dd> +<dt><a href="org/apache/datasketches/hll/TgtHllType.html#HLL_6" class="member-name-link">HLL_6</a> - Enum constant in enum class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></dt> +<dd> +<div class="block">An HLL sketch with a bin size of 6 bits</div> +</dd> +<dt><a href="org/apache/datasketches/hll/TgtHllType.html#HLL_8" class="member-name-link">HLL_8</a> - Enum constant in enum class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></dt> +<dd> +<div class="block">An Hll Sketch with a bin size of 8 bits</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html" class="type-name-link" title="class in org.apache.datasketches.hll">HllSketch</a> - Class in <a href="org/apache/datasketches/hll/package-summary.html">org.apache.datasketches.hll</a></dt> +<dd> +<div class="block">The HllSketch is actually a collection of compact implementations of Phillipe Flajolet’s HyperLogLog (HLL) + sketch but with significantly improved error behavior and excellent speed performance.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#%3Cinit%3E()" class="member-name-link">HllSketch()</a> - Constructor for class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Constructs a new on-heap sketch with the default lgConfigK and tgtHllType.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#%3Cinit%3E(int)" class="member-name-link">HllSketch(int)</a> - Constructor for class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Constructs a new on-heap sketch with the default tgtHllType.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType)" class="member-name-link">HllSketch(int, TgtHllType)</a> - Constructor for class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Constructs a new on-heap sketch with the type of HLL sketch to configure.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">HllSketch(int, TgtHllType, WritableMemory)</a> - Constructor for class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Constructs a new sketch with the type of HLL sketch to configure and the given + WritableMemory as the destination for the sketch.</div> +</dd> +</dl> +<h2 class="title" id="I:I">I</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Family.html#idToFamily(int)" class="member-name-link">idToFamily(int)</a> - Static method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns the Family given the ID</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/BoundsRule.html#INCLUDE_BOTH" class="member-name-link">INCLUDE_BOTH</a> - Enum constant in enum class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></dt> +<dd> +<div class="block">Include both the upper and lower bounds</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/BoundsRule.html#INCLUDE_LOWER" class="member-name-link">INCLUDE_LOWER</a> - Enum constant in enum class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></dt> +<dd> +<div class="block">Include only the lower bound but not the upper bound</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/BoundsRule.html#INCLUDE_NEITHER" class="member-name-link">INCLUDE_NEITHER</a> - Enum constant in enum class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></dt> +<dd> +<div class="block">Include none</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/BoundsRule.html#INCLUDE_UPPER" class="member-name-link">INCLUDE_UPPER</a> - Enum constant in enum class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></dt> +<dd> +<div class="block">Include only the upper bound but not the lower bound</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html#includeDoublesMinMax(double%5B%5D,long%5B%5D,double,double)" class="member-name-link">includeDoublesMinMax(double[], long[], double, double)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dt> +<dd> +<div class="block">The logic to include the min and max of type double.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html#includeFloatsMinMax(float%5B%5D,long%5B%5D,float,float)" class="member-name-link">includeFloatsMinMax(float[], long[], float, float)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dt> +<dd> +<div class="block">The logic to include the min and max of type float.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html#includeItemsMinMax(T%5B%5D,long%5B%5D,T,T,java.util.Comparator)" class="member-name-link">includeItemsMinMax(T[], long[], T, T, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dt> +<dd> +<div class="block">The logic to include the min and max of type T.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html#includeLongsMinMax(long%5B%5D,long%5B%5D,long,long)" class="member-name-link">includeLongsMinMax(long[], long[], long, long)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dt> +<dd> +<div class="block">The logic to include the min and max of type double.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This class reinserts the min and max values into the sorted view arrays as required.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html#%3Cinit%3E()" class="member-name-link">IncludeMinMax()</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">A simple structure to hold a pair of arrays</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">A simple structure to hold a pair of arrays</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" title="type parameter in IncludeMinMax.ItemsPair">T</a>> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">A simple structure to hold a pair of arrays</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">A simple structure to hold a pair of arrays</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html#INCLUSIVE" class="member-name-link">INCLUSIVE</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></dt> +<dd> +<div class="block"><b>Definition of INCLUSIVE <i>getQuantile(r)</i> search:</b><br> + Given rank <i>r</i>, return the quantile of the smallest rank that is + strictly greater than or equal to <i>r</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> - Enum Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#init(java.lang.String,int,double,double,double,double,double)" class="member-name-link">init(String, int, double, double, double, double, double)</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> +<div class="block">Specifies the parameters to be listed as columns</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#initializeByAccuracy(long,double,long,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeByAccuracy(long, double, long, WritableMemory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#initializeByAccuracy(long,double,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeByAccuracy(long, double, WritableMemory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#initializeBySize(long,int,long,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeBySize(long, int, long, WritableMemory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#initializeBySize(long,int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeBySize(long, int, WritableMemory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#InsertedCountIncremented" class="member-name-link">InsertedCountIncremented</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was accepted into the sketch and the retained count was incremented.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#InsertedCountIncrementedRebuilt" class="member-name-link">InsertedCountIncrementedRebuilt</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was accepted into the sketch, the retained count was incremented.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#InsertedCountIncrementedResized" class="member-name-link">InsertedCountIncrementedResized</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was accepted into the sketch, the retained count was incremented.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#InsertedCountNotIncremented" class="member-name-link">InsertedCountNotIncremented</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was accepted into the sketch and the retained count was not incremented.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a> - Class in <a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch(int, int, float, IntegerSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></dt> +<dd> +<div class="block">Creates this sketch with the following parameters:</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html#%3Cinit%3E(int,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch(int, IntegerSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></dt> +<dd> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch(Memory, IntegerSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> - Class in <a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></dt> +<dd> +<div class="block">Summary for generic tuple sketches of type Integer.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummary(IntegerSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></dt> +<dd> +<div class="block">Creates an instance of IntegerSummary with a given mode.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> - Enum Class in <a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></dt> +<dd> +<div class="block">The aggregation modes for this Summary</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a> - Class in <a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html#%3Cinit%3E()" class="member-name-link">IntegerSummaryDeserializer()</a> - Constructor for class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a> - Class in <a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></dt> +<dd> +<div class="block">Factory for IntegerSummary.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummaryFactory(IntegerSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a></dt> +<dd> +<div class="block">Creates an instance of IntegerSummaryFactory with a given mode</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a> - Class in <a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></dt> +<dd> +<div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary + are performed.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummarySetOperations(IntegerSummary.Mode, IntegerSummary.Mode)</a> - Constructor for class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></dt> +<dd> +<div class="block">Creates a new instance with two modes</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#intersect(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">intersect(BloomFilter)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Intersects two BloomFilters by applying a logical AND.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#intersect(org.apache.datasketches.theta.Sketch)" class="member-name-link">intersect(Sketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Intersect the given sketch with the internal state.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">intersect(Sketch, Sketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Perform intersect set operation on the two given sketch arguments and return the result as an + ordered CompactSketch on the heap.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">intersect(Sketch, Sketch, boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Perform intersect set operation on the two given sketches and return the result as a + CompactSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#intersect(org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect(Sketch, S)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Performs a stateful intersection of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary and rules + from the summarySetOps defined by the Intersection constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html#intersect(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner)" class="member-name-link">intersect(ArrayOfDoublesSketch, ArrayOfDoublesCombiner)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></dt> +<dd> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#intersect(org.apache.datasketches.tuple.Sketch)" class="member-name-link">intersect(Sketch<S>)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect(Sketch<S>, Sketch, S)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the + result as an unordered CompactSketch on the heap.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">intersect(Sketch<S>, Sketch<S>)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Perform a stateless intersect set operation on the two given tuple sketches and returns the + result as an unordered CompactSketch on the heap.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html#intersection(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">intersection(DoubleSummary, DoubleSummary)</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html#intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">intersection(IntegerSummary, IntegerSummary)</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html#intersection(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">intersection(ArrayOfStringsSummary, ArrayOfStringsSummary)</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/SummarySetOperations.html#intersection(S,S)" class="member-name-link">intersection(S, S)</a> - Method in interface org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></dt> +<dd> +<div class="block">This is called by the intersection operator when both sketches have the same hash value.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html" class="type-name-link" title="class in org.apache.datasketches.theta">Intersection</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">The API for intersection operations</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Intersection</a><<a href="org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches + combined with theta sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#%3Cinit%3E()" class="member-name-link">Intersection()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Intersection(SummarySetOperations<S>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Creates new Intersection instance with instructions on how to process two summaries that + intersect.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#INTERSECTION" class="member-name-link">INTERSECTION</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Intersection family is an operation for the Theta Sketch Framework of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#intToBytes(int,byte%5B%5D)" class="member-name-link">intToBytes(int, byte[])</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns a Little-Endian byte array extracted from the given int.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#INVERSE_GOLDEN" class="member-name-link">INVERSE_GOLDEN</a> - Static variable in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">The inverse golden ratio as a fraction.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#INVERSE_GOLDEN_U64" class="member-name-link">INVERSE_GOLDEN_U64</a> - Static variable in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">The inverse golden ratio as an unsigned long.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#invert()" class="member-name-link">invert()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Inverts all the bits of the BloomFilter.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#invPow2(int)" class="member-name-link">invPow2(int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the inverse integer power of 2: 1/(2^e) = 2^(-e).</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#isCompact()" class="member-name-link">isCompact()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#isCompact()" class="member-name-link">isCompact()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#isCompact()" class="member-name-link">isCompact()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#isCompact()" class="member-name-link">isCompact()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns true if this sketch is in compact form.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#isCompact()" class="member-name-link">isCompact()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#isCompactMemoryFormat()" class="member-name-link">isCompactMemoryFormat()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Returns true if this sketch is in a Compact Memory Format.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#isCompatible(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">isCompatible(BloomFilter)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Helps identify if two BloomFilters may be unioned or intersected.</div> +</dd> +<dt><a href="org/apache/datasketches/common/MemoryStatus.html#isDirect()" class="member-name-link">isDirect()</a> - Method in interface org.apache.datasketches.common.<a href="org/apache/datasketches/common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></dt> +<dd> +<div class="block">Returns true if this object's internal data is backed by direct (off-heap) Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns whether the filter is a direct (off-heap) or on-heap object.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns true if this union is off-heap (direct)</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Returns true if this union is direct</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#isDirect()" class="member-name-link">isDirect()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#isDirect()" class="member-name-link">isDirect()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return true if this sketch is empty</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Checks if the BloomFilter has processed any items</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns true if this sketch is empty</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns true if this sketch is empty</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns true if this union is empty</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Returns true if this union is empty</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Returns true if this sketch is empty.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedView.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></dt> +<dd> +<div class="block">Returns true if this sorted view is empty.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns true if the sketch is empty.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block"><a href="./resources/dictionary.html#empty">See Empty</a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block"><a href="./resources/dictionary.html#empty">See Empty</a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#isEmpty()" class="member-name-link">isEmpty()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block"><a href="./resources/dictionary.html#empty">See Empty</a></div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">This HLL family of sketches and operators is always estimating, even for very small values.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Returns true if this sketch is in estimation mode.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#isEstimationMode()" class="member-name-link">isEstimationMode()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#isEven(long)" class="member-name-link">isEven(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns true if given n is even.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#isLessThanUnsigned(long,long)" class="member-name-link">isLessThanUnsigned(long, long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Unsigned compare with longs.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#isMemory()" class="member-name-link">isMemory()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#isMemory()" class="member-name-link">isMemory()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#isMemoryUpdatableFormat()" class="member-name-link">isMemoryUpdatableFormat()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Returns true if the backing WritableMemory is in updatable format.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#isMultipleOf8AndGT0(long)" class="member-name-link">isMultipleOf8AndGT0(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns true if v is a multiple of 8 and greater than zero</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#isOdd(long)" class="member-name-link">isOdd(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns true if given n is odd.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#isOffHeap()" class="member-name-link">isOffHeap()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#isOffHeap()" class="member-name-link">isOffHeap()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#isOrdered()" class="member-name-link">isOrdered()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns true if internal cache is ordered</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#isOrdered()" class="member-name-link">isOrdered()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/Util.html#isPowerOf2(long)" class="member-name-link">isPowerOf2(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns true if given long argument is exactly a positive power of 2.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Returns whether the filter is in read-only mode.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Returns true if this sketch is read only.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#isReadOnly()" class="member-name-link">isReadOnly()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource(Memory)</a> - Method in interface org.apache.datasketches.common.<a href="org/apache/datasketches/common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></dt> +<dd> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource(Memory)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource(Memory)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource(Memory)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource(Memory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource(Memory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#items()" class="member-name-link">items()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt> +<dd> +<div class="block">Returns a shallow copy of the array of sample items contained in the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#items(int)" class="member-name-link">items(int)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt> +<dd> +<div class="block">Returns a single item from the samples contained in the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#ITEMS_SKETCH" class="member-name-link">ITEMS_SKETCH</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">KllItemsSketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html#%3Cinit%3E(T%5B%5D,long%5B%5D)" class="member-name-link">ItemsPair(T[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> - Class in <a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></dt> +<dd> +<div class="block">This sketch is useful for tracking approximate frequencies of items of type <i><T></i> + with optional associated counts (<i><T></i> item, <i>long</i> count) that are members of a + multiset of such items.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#%3Cinit%3E(int)" class="member-name-link">ItemsSketch(int)</a> - Constructor for class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Construct this sketch with the parameter maxMapSize and the default initialMapSize (8).</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>> - Class in <a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></dt> +<dd> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><<a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="type parameter in ItemsSketchIterator">T</a>> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">Iterator over ItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#%3Cinit%3E(T%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesGenericAPI)" class="member-name-link">ItemsSketchSortedView(T[], long[], QuantilesGenericAPI<T>)</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> +<div class="block">The API for Union operations for generic ItemsSketches</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedView.html#iterator()" class="member-name-link">iterator()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></dt> +<dd> +<div class="block">Returns an iterator for this Sorted View.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns a HashIterator that can be used to iterate over the retained hash values of the + Theta sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/CompactSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#iterator()" class="member-name-link">iterator()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">Returns a SketchIterator</div> +</dd> +</dl> +<h2 class="title" id="I:J">J</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/theta/JaccardSimilarity.html#jaccard(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">jaccard(Sketch, Sketch)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></dt> +<dd> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard(Sketch<S>, Sketch, S, SummarySetOperations<S>)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard(Sketch<S>, Sketch<S>, SummarySetOperations<S>)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/JaccardSimilarity.html" class="type-name-link" title="class in org.apache.datasketches.theta">JaccardSimilarity</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">Jaccard similarity of two Theta Sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html" class="type-name-link" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Jaccard similarity of two Tuple Sketches, or alternatively, of a Tuple and Theta Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/JaccardSimilarity.html#%3Cinit%3E()" class="member-name-link">JaccardSimilarity()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#%3Cinit%3E()" class="member-name-link">JaccardSimilarity()</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/SuppressFBWarnings.html#justification()" class="member-name-link">justification()</a> - Element in annotation interface org.apache.datasketches.common.<a href="org/apache/datasketches/common/SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></dt> +<dd> +<div class="block">Optional explanation for the suppression.</div> +</dd> +</dl> +<h2 class="title" id="I:K">K</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Family.html#KLL" class="member-name-link">KLL</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">KLL quantiles sketch</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketch</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">Iterator over KllDoublesSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">Iterator over KllFloatsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><<a href="org/apache/datasketches/kll/KllItemsSketchIterator.html" title="type parameter in KllItemsSketchIterator">T</a>> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">Iterator over KllItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketch</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">Iterator over KllLongsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketch</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">This class is the root of the KLL sketch class hierarchy.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a> - Enum Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">Used primarily to define the structure of the serialized sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a> - Enum Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">Used to define the variable type of the current instance of this class.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketchIterator</a> - Class in <a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></dt> +<dd> +<div class="block">The base implementation for the KLL sketch iterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">Kolmogorov-Smirnov Test + See <a href="https://en.wikipedia.org/wiki/Kolmogorov-Smirnov_test">Kolmogorov–Smirnov Test</a></div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html#%3Cinit%3E()" class="member-name-link">KolmogorovSmirnov()</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html#kolmogorovSmirnovTest(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)" class="member-name-link">kolmogorovSmirnovTest(QuantilesAPI, QuantilesAPI, double)</a> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></dt> +<dd> +<div class="block">Performs the Kolmogorov-Smirnov Test between two QuantilesAPI sketches.</div> +</dd> +</dl> +<h2 class="title" id="I:L">L</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Util.html#le(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">le(Object, Object, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Is item1 Less-Than-Or-Equal-To item2</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html#LE" class="member-name-link">LE</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#LE" class="member-name-link">LE</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html#levelPartId" class="member-name-link">levelPartId</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></dt> +<dd> +<div class="block">A brief string description of the partition and its hierarchy</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.StackElement.html#levelPartId" class="member-name-link">levelPartId</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a></dt> +<dd> +<div class="block">A brief string description of the partition and its hierarchy</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#lg()" class="member-name-link">lg()</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Returns the Log-base 2 of the Resize Factor</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#log2(double)" class="member-name-link">log2(double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">The log<sub>2</sub>(value)</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#LOG2" class="member-name-link">LOG2</a> - Static variable in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">The natural logarithm of 2.0.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#logBaseOfX(double,double)" class="member-name-link">logBaseOfX(double, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the log<sub>base</sub>(x).</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#LONG_MAX_VALUE_AS_DOUBLE" class="member-name-link">LONG_MAX_VALUE_AS_DOUBLE</a> - Static variable in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Long.MAX_VALUE as a double.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#LONGS_SKETCH" class="member-name-link">LONGS_SKETCH</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">KllDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html#%3Cinit%3E(long%5B%5D,long%5B%5D)" class="member-name-link">LongsPair(long[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch</a> - Class in <a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></dt> +<dd> +<div class="block">This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional + associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of + such items.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#%3Cinit%3E(int)" class="member-name-link">LongsSketch(int)</a> - Constructor for class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Construct this sketch with the parameter maxMapSize and the default initialMapSize (8).</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a> - Class in <a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></dt> +<dd> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The SortedView of the KllLongsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html#%3Cinit%3E(long%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesLongsAPI)" class="member-name-link">LongsSketchSortedView(long[], long[], QuantilesLongsAPI)</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></dt> +<dd> +<div class="block">Construct from elements, also used in testing.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Sorted View for quantile sketches of primitive type long.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">Iterator over quantile sketches of primitive type <i>long</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html#%3Cinit%3E(long%5B%5D,long%5B%5D)" class="member-name-link">LongsSortedViewIterator(long[], long[])</a> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></dt> +<dd> +<div class="block">Constructor.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#longToBytes(long,byte%5B%5D)" class="member-name-link">longToBytes(long, byte[])</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns a Little-Endian byte array extracted from the given long.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#longToFixedLengthString(long,int)" class="member-name-link">longToFixedLengthString(long, int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Converts the given number to a string prepended with spaces, if necessary, to + match the given length.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#longToHexBytes(long)" class="member-name-link">longToHexBytes(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns a string of spaced hex bytes in Big-Endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html#lowerBound" class="member-name-link">lowerBound</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></dt> +<dd> +<div class="block">The lower bound value</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#LS" class="member-name-link">LS</a> - Static variable in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">The java line separator character as a String.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#lt(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">lt(Object, Object, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Is item1 Less-Than item2</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html#LT" class="member-name-link">LT</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>v</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A < v ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#LT" class="member-name-link">LT</a> - Enum constant in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>v</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A < v ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</dd> +</dl> +<h2 class="title" id="I:M">M</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html#Max" class="member-name-link">Max</a> - Enum constant in enum class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is the maximum function.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html#Max" class="member-name-link">Max</a> - Enum constant in enum class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is the maximum function.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#MAX_K" class="member-name-link">MAX_K</a> - Static variable in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">The maximum K</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#MAX_LG_NOM_LONGS" class="member-name-link">MAX_LG_NOM_LONGS</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">The largest Log2 nom entries allowed: 26.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#MAX_SIZE_BITS" class="member-name-link">MAX_SIZE_BITS</a> - Static variable in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">The maximum size of a bloom filter in bits.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#maxT(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">maxT(Object, Object, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Finds the maximum of two generic items</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG" class="member-name-link">MEM_REQ_SVR_NULL_MSG</a> - Static variable in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">MemoryRequestServer must not be null.</div> +</dd> +<dt><a href="org/apache/datasketches/common/MemoryStatus.html" class="type-name-link" title="interface in org.apache.datasketches.common">MemoryStatus</a> - Interface in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Methods for inquiring the status of a backing Memory object.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#merge(org.apache.datasketches.frequencies.ItemsSketch)" class="member-name-link">merge(ItemsSketch<T>)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">This function merges the other sketch into this one.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#merge(org.apache.datasketches.frequencies.LongsSketch)" class="member-name-link">merge(LongsSketch)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">This function merges the other sketch into this one.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge(KllSketch)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge(KllSketch)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge(KllSketch)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge(KllSketch)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge(KllSketch)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Merges another sketch into this one.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#merge(org.apache.datasketches.req.ReqSketch)" class="member-name-link">merge(ReqSketch)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#merge(org.apache.datasketches.sampling.EbppsItemsSketch)" class="member-name-link">merge(EbppsItemsSketch<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Merges the provided sketch into the current one.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#merge(org.apache.datasketches.tdigest.TDigestDouble)" class="member-name-link">merge(TDigestDouble)</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Merge the given TDigest into this one</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/MergingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">MergingValidation</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/MergingValidation.html#%3Cinit%3E(int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">MergingValidation(int, int, int, int, int, PrintStream, PrintWriter)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/MergingValidation.html" title="class in org.apache.datasketches.cpc">MergingValidation</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/Util.html#milliSecToString(long)" class="member-name-link">milliSecToString(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the given time in milliseconds formatted as Hours:Min:Sec.mSec</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html#Min" class="member-name-link">Min</a> - Enum constant in enum class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is the minimum function.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html#Min" class="member-name-link">Min</a> - Enum constant in enum class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is the minimum function.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#MIN_LG_ARR_LONGS" class="member-name-link">MIN_LG_ARR_LONGS</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">The smallest Log2 cache size allowed: 5.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#MIN_LG_NOM_LONGS" class="member-name-link">MIN_LG_NOM_LONGS</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">The smallest Log2 nom entries allowed: 4.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#minLgHashTableSize(int,double)" class="member-name-link">minLgHashTableSize(int, double)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">Returns the smallest log hash table size given the count of items and the rebuild threshold.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#minT(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">minT(Object, Object, Comparator<? super T>)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Finds the minimum of two generic items</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#modulo(long%5B%5D,int)" class="member-name-link">modulo(long[], int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns the remainder from the modulo division of the 128-bit output of the murmurHash3 by the + divisor.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html#modulo(long,long,int)" class="member-name-link">modulo(long, long, int)</a> - Static method in class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></dt> +<dd> +<div class="block">Returns the remainder from the modulo division of the 128-bit output of the murmurHash3 by the + divisor.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3.html" class="type-name-link" title="class in org.apache.datasketches.hash">MurmurHash3</a> - Class in <a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a></dt> +<dd> +<div class="block">The MurmurHash3 is a fast, non-cryptographic, 128-bit hash function that has + excellent avalanche and 2-way bit independence properties.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" class="type-name-link" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a> - Class in <a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a></dt> +<dd> +<div class="block">A general purpose wrapper for the MurmurHash3.</div> +</dd> +</dl> +<h2 class="title" id="I:N">N</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Util.html#nanoSecToString(long)" class="member-name-link">nanoSecToString(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the given time in nanoseconds formatted as Sec.mSec_uSec_nSec</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance(int, WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance(int, WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance(int, WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance(WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance(WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance(WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#newHeapInstance()" class="member-name-link">newHeapInstance()</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#newHeapInstance()" class="member-name-link">newHeapInstance()</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#newHeapInstance()" class="member-name-link">newHeapInstance()</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#newHeapInstance(int)" class="member-name-link">newHeapInstance(int)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#newHeapInstance(int)" class="member-name-link">newHeapInstance(int)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#newHeapInstance(int)" class="member-name-link">newHeapInstance(int)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#newHeapInstance(int,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance(int, Comparator<? super T>, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#newHeapInstance(java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance(Comparator<? super T>, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#newInstance(int)" class="member-name-link">newInstance(int)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Construct a mergeable sampling sketch with up to k samples using the default resize + factor (8).</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#newInstance(int)" class="member-name-link">newInstance(int)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#newInstance(int)" class="member-name-link">newInstance(int)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#newInstance(int)" class="member-name-link">newInstance(int)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#newInstance(int)" class="member-name-link">newInstance(int)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Construct a varopt sampling sketch with up to k samples using the default resize factor (8).</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#newInstance(int)" class="member-name-link">newInstance(int)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Creates an empty Union with a maximum capacity of size k.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance(int, ResizeFactor)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Construct a mergeable sampling sketch with up to k samples using a specified resize factor.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance(int, ResizeFactor)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance(int, ResizeFactor)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Construct a varopt sampling sketch with up to k samples using the specified resize factor.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html#newSummary()" class="member-name-link">newSummary()</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html#newSummary()" class="member-name-link">newSummary()</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html#newSummary()" class="member-name-link">newSummary()</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/SummaryFactory.html#newSummary()" class="member-name-link">newSummary()</a> - Method in interface org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#newSummaryArray(S%5B%5D,int)" class="member-name-link">newSummaryArray(S[], int)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Creates a new Summary Array with the specified length</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketchIterator.html#next()" class="member-name-link">next()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html#next()" class="member-name-link">next()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html#next()" class="member-name-link">next()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html#next()" class="member-name-link">next()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></dt> +<dd> +<div class="block">Advances the index and checks if it is valid.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#next()" class="member-name-link">next()</a> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt> +<dd> +<div class="block">Advances the index and checks if it is valid.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchIterator.html#next()" class="member-name-link">next()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html#next()" class="member-name-link">next()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.VarOptItemsIterator</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/HashIterator.html#next()" class="member-name-link">next()</a> - Method in interface org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></dt> +<dd> +<div class="block">Returns true at the next hash value in sequence.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html#next()" class="member-name-link">next()</a> - Method in interface org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></dt> +<dd> +<div class="block">Advancing the iterator and checking existence of the next entry + is combined here for efficiency.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/TupleSketchIterator.html#next()" class="member-name-link">next()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a></dt> +<dd> +<div class="block">Advancing the iterator and checking existence of the next entry + is combined here for efficiency.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ErrorType.html#NO_FALSE_NEGATIVES" class="member-name-link">NO_FALSE_NEGATIVES</a> - Enum constant in enum class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></dt> +<dd> +<div class="block">No <i>Type II</i> error samples will be excluded from the sample set, + which means all <i>Truly Positive</i> samples will be included in the sample set.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ErrorType.html#NO_FALSE_POSITIVES" class="member-name-link">NO_FALSE_POSITIVES</a> - Enum constant in enum class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></dt> +<dd> +<div class="block">No <i>Type I</i> error samples will be included in the sample set, + which means all <i>Truly Negative</i> samples will be excluded from the sample set.</div> +</dd> +<dt><a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html#normalCDF(double)" class="member-name-link">normalCDF(double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></dt> +<dd> +<div class="block">Computes an approximation to normalCDF(x).</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG" class="member-name-link">NOT_SINGLE_ITEM_MSG</a> - Static variable in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Sketch does not have just one item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#notB(org.apache.datasketches.theta.Sketch)" class="member-name-link">notB(Sketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#notB(org.apache.datasketches.theta.Sketch)" class="member-name-link">notB(Sketch)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#notB(org.apache.datasketches.tuple.Sketch)" class="member-name-link">notB(Sketch<S>)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#numberOfLeadingOnes(long)" class="member-name-link">numberOfLeadingOnes(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the number of one bits preceding the highest-order ("leftmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#numberOfTrailingOnes(long)" class="member-name-link">numberOfTrailingOnes(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Returns the number of one bits following the lowest-order ("rightmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#numDigits(long)" class="member-name-link">numDigits(long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the number of decimal digits of the number n</div> +</dd> +</dl> +<h2 class="title" id="I:O">O</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/package-summary.html">org.apache.datasketches</a> - package org.apache.datasketches</dt> +<dd> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</dd> +<dt><a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a> - package org.apache.datasketches.common</dt> +<dd> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a> - package org.apache.datasketches.cpc</dt> +<dd> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a> - package org.apache.datasketches.fdt</dt> +<dd> +<div class="block">Frequent Distinct Tuples Sketch</div> +</dd> +<dt><a href="org/apache/datasketches/filters/package-summary.html">org.apache.datasketches.filters</a> - package org.apache.datasketches.filters</dt> +<dd> +<div class="block">The filters package contains data structures used to determine + approximate set-membership.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a> - package org.apache.datasketches.filters.bloomfilter</dt> +<dd> +<div class="block">BloomFilter package</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a> - package org.apache.datasketches.frequencies</dt> +<dd> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a> - package org.apache.datasketches.hash</dt> +<dd> +<div class="block">The hash package contains a high-performing and extended Java implementations + of Austin Appleby's 128-bit MurmurHash3 hash function originally coded in C.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/package-summary.html">org.apache.datasketches.hll</a> - package org.apache.datasketches.hll</dt> +<dd> +<div class="block">The DataSketches™ HLL sketch family package</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/package-summary.html">org.apache.datasketches.hllmap</a> - package org.apache.datasketches.hllmap</dt> +<dd> +<div class="block">The hllmap package contains a space efficient HLL mapping sketch of keys to approximate unique + count of identifiers.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a> - package org.apache.datasketches.kll</dt> +<dd> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a> - package org.apache.datasketches.partitions</dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a> - package org.apache.datasketches.quantiles</dt> +<dd> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a> - package org.apache.datasketches.quantilescommon</dt> +<dd> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</dd> +<dt><a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a> - package org.apache.datasketches.req</dt> +<dd> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a> - package org.apache.datasketches.sampling</dt> +<dd> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/package-summary.html">org.apache.datasketches.tdigest</a> - package org.apache.datasketches.tdigest</dt> +<dd> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a> - package org.apache.datasketches.theta</dt> +<dd> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="./resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a> - package org.apache.datasketches.thetacommon</dt> +<dd> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a> - package org.apache.datasketches.tuple</dt> +<dd> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> - package org.apache.datasketches.tuple.adouble</dt> +<dd> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> - package org.apache.datasketches.tuple.aninteger</dt> +<dd> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> - package org.apache.datasketches.tuple.arrayofdoubles</dt> +<dd> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a> - package org.apache.datasketches.tuple.strings</dt> +<dd> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</dd> +</dl> +<h2 class="title" id="I:P">P</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/theta/BitPacking.html#packBits(long,int,byte%5B%5D,int,int)" class="member-name-link">packBits(long, int, byte[], int, int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/BitPacking.html" title="class in org.apache.datasketches.theta">BitPacking</a></dt> +<dd> +<div class="block">The bit packing operation</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html#part" class="member-name-link">part</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></dt> +<dd> +<div class="block">The partition index</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.StackElement.html#part" class="member-name-link">part</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a></dt> +<dd> +<div class="block">The partition index</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.html#partition(S)" class="member-name-link">partition(S)</a> - Method in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a></dt> +<dd> +<div class="block">This initiates the partitioning process</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html#%3Cinit%3E(org.apache.datasketches.partitions.Partitioner.StackElement)" class="member-name-link">PartitionBoundsRow(Partitioner.StackElement<T>)</a> - Constructor for class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></dt> +<dd> +<div class="block">The constructor for the StackElement class.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner</a><<a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">S</a> extends <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">T</a>> & <a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="org/apache/datasketches/partitions/Partitioner.html" title="type parameter in Partitioner">T</a>>> - Class in <a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></dt> +<dd> +<div class="block">A partitioning process that can partition very large data sets into thousands + of partitions of approximately the same size.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.html#%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest)" class="member-name-link">Partitioner(long, int, SketchFillRequest<T, S>)</a> - Constructor for class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a></dt> +<dd> +<div class="block">This constructor assumes a QuantileSearchCriteria of INCLUSIVE.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.html#%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">Partitioner(long, int, SketchFillRequest<T, S>, QuantileSearchCriteria)</a> - Constructor for class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a></dt> +<dd> +<div class="block">This constructor includes the QuantileSearchCriteria criteria as a parameter.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a>> - Class in <a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></dt> +<dd> +<div class="block">Defines a row for List of PartitionBounds.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><<a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>> - Class in <a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></dt> +<dd> +<div class="block">Holds data for a Stack element</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/PostProcessor.html" class="type-name-link" title="class in org.apache.datasketches.fdt">PostProcessor</a> - Class in <a href="org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a></dt> +<dd> +<div class="block">This processes the contents of a FDT sketch to extract the + primary keys with the most frequent unique combinations of the non-primary dimensions.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/PostProcessor.html#%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch,org.apache.datasketches.fdt.Group,char)" class="member-name-link">PostProcessor(FdtSketch, Group, char)</a> - Constructor for class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></dt> +<dd> +<div class="block">Construct with a populated FdtSketch</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#powerSeriesNextDouble(int,double,boolean,double)" class="member-name-link">powerSeriesNextDouble(int, double, boolean, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the next larger double in the power series + <i>point = logBase<sup>( i / ppb )</sup></i> given the current point in the series.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putDoubleBE(byte%5B%5D,int,double)" class="member-name-link">putDoubleBE(byte[], int, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>double</i> into the destination byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putDoubleLE(byte%5B%5D,int,double)" class="member-name-link">putDoubleLE(byte[], int, double)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>double</i> into the destination byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putFloatBE(byte%5B%5D,int,float)" class="member-name-link">putFloatBE(byte[], int, float)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>float</i> into the destination byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putFloatLE(byte%5B%5D,int,float)" class="member-name-link">putFloatLE(byte[], int, float)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>float</i> into the destination byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putIntBE(byte%5B%5D,int,int)" class="member-name-link">putIntBE(byte[], int, int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>int</i> into the destination byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putIntLE(byte%5B%5D,int,int)" class="member-name-link">putIntLE(byte[], int, int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>int</i> into the destination byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putLongBE(byte%5B%5D,int,long)" class="member-name-link">putLongBE(byte[], int, long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>long</i> into the destination byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putLongLE(byte%5B%5D,int,long)" class="member-name-link">putLongLE(byte[], int, long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>long</i> into the destination byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">putMemory(WritableMemory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Puts the current sketch into the given Memory in compact form if there is sufficient space, + otherwise, it throws an error.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory,boolean)" class="member-name-link">putMemory(WritableMemory, boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Puts the current sketch into the given Memory if there is sufficient space, otherwise, + throws an error.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">putMemory(WritableMemory, ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Puts the current sketch into the given Memory if there is sufficient space.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putShortBE(byte%5B%5D,int,short)" class="member-name-link">putShortBE(byte[], int, short)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>short</i> into the destination byte array starting at the given offset + in big endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ByteArrayUtil.html#putShortLE(byte%5B%5D,int,short)" class="member-name-link">putShortLE(byte[], int, short)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></dt> +<dd> +<div class="block">Put the source <i>short</i> into the destination byte array starting at the given offset + in little endian order.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#pwr2SeriesNext(int,long)" class="member-name-link">pwr2SeriesNext(int, long)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the next larger integer point in the power series + <i>point = 2<sup>( i / ppo )</sup></i> given the current point in the series.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html#pwr2SeriesPrev(int,int)" class="member-name-link">pwr2SeriesPrev(int, int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Computes the previous, smaller integer point in the power series + <i>point = 2<sup>( i / ppo )</sup></i> given the current point in the series.</div> +</dd> +</dl> +<h2 class="title" id="I:Q">Q</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html#quantiles" class="member-name-link">quantiles</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></dt> +<dd> +<div class="block">the array of quantiles</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html#quantiles" class="member-name-link">quantiles</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></dt> +<dd> +<div class="block">The array of quantiles</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html#quantiles" class="member-name-link">quantiles</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a></dt> +<dd> +<div class="block">The array of quantiles</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html#quantiles" class="member-name-link">quantiles</a> - Variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></dt> +<dd> +<div class="block">the array of quantiles</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#QUANTILES" class="member-name-link">QUANTILES</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Quantiles family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> - Enum Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" title="type parameter in QuantilesGenericSketchIterator">T</a>> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The quantiles sketch iterator for generic types.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The Quantiles API for item type <i>long</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">The quantiles sketch iterator for primitive type long.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">Utilities for the quantiles sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(byte%5B%5D)" class="member-name-link">query(byte[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided byte[] and returns whether the + array <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(char%5B%5D)" class="member-name-link">query(char[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided char[] and returns whether the + array <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(double)" class="member-name-link">query(double)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided double and returns whether the + value <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(int%5B%5D)" class="member-name-link">query(int[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided int[] and returns whether the + array <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(long)" class="member-name-link">query(long)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided long and returns whether the + value <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(long%5B%5D)" class="member-name-link">query(long[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided long[] and returns whether the + array <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(short%5B%5D)" class="member-name-link">query(short[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided short[] and returns whether the + array <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(java.lang.String)" class="member-name-link">query(String)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided double and returns whether the + value <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#query(org.apache.datasketches.memory.Memory)" class="member-name-link">query(Memory)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Queries the filter with the provided Memory and returns whether the + data <em>might</em> have been seen previously.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(byte%5B%5D)" class="member-name-link">queryAndUpdate(byte[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided byte[] and + returns the result from quering that array prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(char%5B%5D)" class="member-name-link">queryAndUpdate(char[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided char[] and + returns the result from quering that array prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(double)" class="member-name-link">queryAndUpdate(double)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided double and + returns the result from quering that value prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(int%5B%5D)" class="member-name-link">queryAndUpdate(int[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided int[] and + returns the result from quering that array prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(long)" class="member-name-link">queryAndUpdate(long)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided long and + returns the result from quering that value prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(long%5B%5D)" class="member-name-link">queryAndUpdate(long[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided long[] and + returns the result from quering that array prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(short%5B%5D)" class="member-name-link">queryAndUpdate(short[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided short[] and + returns the result from quering that array prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(java.lang.String)" class="member-name-link">queryAndUpdate(String)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided String and + returns the result from quering that value prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#queryAndUpdate(org.apache.datasketches.memory.Memory)" class="member-name-link">queryAndUpdate(Memory)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided Memory and + returns the result from quering that Memory prior to the update.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/QuickMergingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/QuickMergingValidation.html#%3Cinit%3E(int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">QuickMergingValidation(int, int, int, PrintStream, PrintWriter)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/QuickMergingValidation.html" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/QuickSelect.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">QuickSelect</a> - Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">QuickSelect algorithm improved from Sedgewick.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#QUICKSELECT" class="member-name-link">QUICKSELECT</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The QuickSelect Sketch family is a member of the Theta Sketch Framework of sketches and + is the workhorse of the Theta Sketch Families and can be constructed for either on-heap or + off-heap operation.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html#QuickSelectSketch" class="member-name-link">QuickSelectSketch</a> - Enum constant in enum class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></dt> +<dd> +<div class="block">QuickSelectSketch</div> +</dd> +</dl> +<h2 class="title" id="I:R">R</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#rand" class="member-name-link">rand</a> - Static variable in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Setting the seed makes the results of the sketch deterministic if the input items are + received in exactly the same order.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#rebuild()" class="member-name-link">rebuild()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Rebuilds the hash table to remove dirty values or to reduce the size + to nominal entries.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#REBUILD_THRESHOLD" class="member-name-link">REBUILD_THRESHOLD</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">The hash table rebuild threshold = 15.0/16.0.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#RejectedDuplicate" class="member-name-link">RejectedDuplicate</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was rejected as a duplicate.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#RejectedNullOrEmpty" class="member-name-link">RejectedNullOrEmpty</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was rejected because it was null or empty.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#RejectedOverTheta" class="member-name-link">RejectedOverTheta</a> - Enum constant in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">The hash was rejected because the value was negative, zero or + greater than theta.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#REQ" class="member-name-link">REQ</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Relative Error Quantiles Sketch</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqDebug.html" class="type-name-link" title="interface in org.apache.datasketches.req">ReqDebug</a> - Interface in <a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></dt> +<dd> +<div class="block">The signaling interface that allows comprehensive analysis of the ReqSketch and ReqCompactor + while eliminating code clutter in the main classes.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketch</a> - Class in <a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></dt> +<dd> +<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper + "Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty, + Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchBuilder</a> - Class in <a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></dt> +<dd> +<div class="block">For building a new ReqSketch</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#%3Cinit%3E()" class="member-name-link">ReqSketchBuilder()</a> - Constructor for class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">Constructor for the ReqSketchBuilder.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchIterator</a> - Class in <a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></dt> +<dd> +<div class="block">Iterator over all retained items of the ReqSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#RESERVOIR" class="member-name-link">RESERVOIR</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Reservoir family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#RESERVOIR_UNION" class="member-name-link">RESERVOIR_UNION</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The reservoir sampling family of Union operations.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">This sketch provides a reservoir sample over an input stream of items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">Class to union reservoir samples of generic items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">This sketch provides a reservoir sample over an input stream of <code>long</code>s.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">Class to union reservoir samples of longs.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Resets this sketch to empty but retains the original LgK and Seed.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Resets the BloomFilter to an empty state</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Resets this sketch to a virgin state.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Resets this sketch to a virgin state.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Resets to empty and retains the current lgK, but does not change the configured value of + lgMaxK.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Resets this Union to a virgin state.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Resets this Union to a virgin state.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#reset()" class="member-name-link">reset()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Resets the sketch to its default, empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Resets this sketch to the empty state, but retains the original value of max k.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Resets this Intersection for stateful operations only.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Resets this Union.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Resets this sketch back to a virgin empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> +<div class="block">Resets this operation back to the empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></dt> +<dd> +<div class="block">Resets the internal set to the initial state, which represents the Universal Set</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Resets the union to an empty state</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Resets this sketch an empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Intersection.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a></dt> +<dd> +<div class="block">Resets the internal set to the initial state, which represents the Universal Set</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Resets this sketch an empty state.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Resets the internal set to the initial state, which represents an empty set.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html#reset()" class="member-name-link">reset()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></dt> +<dd> +<div class="block">Resets the Nominal Entries, Resize Factor and Sampling Probability to their default values.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#RESIZE_THRESHOLD" class="member-name-link">RESIZE_THRESHOLD</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">The resize threshold = 0.5; tuned for speed.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html" class="type-name-link" title="enum class in org.apache.datasketches.common">ResizeFactor</a> - Enum Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/Sort.html#reverse(double%5B%5D,int)" class="member-name-link">reverse(double[], int)</a> - Static method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/Sort.html" title="class in org.apache.datasketches.tdigest">Sort</a></dt> +<dd> +<div class="block">Reverse the first n elements of the given array.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/Sort.html#reverse(long%5B%5D,int)" class="member-name-link">reverse(long[], int)</a> - Static method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/Sort.html" title="class in org.apache.datasketches.tdigest">Sort</a></dt> +<dd> +<div class="block">Reverse the first n elements of the given array.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html#rule" class="member-name-link">rule</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></dt> +<dd> +<div class="block">The BoundsRule for this partition description row.</div> +</dd> +</dl> +<h2 class="title" id="I:S">S</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" class="type-name-link" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">A simple object o capture the results of a subset sum query on a sampling sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/QuickSelect.html#select(double%5B%5D,int,int,int)" class="member-name-link">select(double[], int, int, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></dt> +<dd> +<div class="block">Gets the 0-based kth order statistic from the array.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/QuickSelect.html#select(long%5B%5D,int,int,int)" class="member-name-link">select(long[], int, int, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></dt> +<dd> +<div class="block">Gets the 0-based kth order statistic from the array.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/QuickSelect.html#selectExcludingZeros(double%5B%5D,int,int)" class="member-name-link">selectExcludingZeros(double[], int, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></dt> +<dd> +<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the + array.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/QuickSelect.html#selectExcludingZeros(long%5B%5D,int,int)" class="member-name-link">selectExcludingZeros(long[], int, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></dt> +<dd> +<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the + array.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/QuickSelect.html#selectIncludingZeros(double%5B%5D,int)" class="member-name-link">selectIncludingZeros(double[], int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></dt> +<dd> +<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the + array.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/QuickSelect.html#selectIncludingZeros(long%5B%5D,int)" class="member-name-link">selectIncludingZeros(long[], int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></dt> +<dd> +<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the + array.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG" class="member-name-link">SELF_MERGE_MSG</a> - Static variable in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">A sketch cannot merge with itself.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Multipurpose serializer-deserializer for a collection of sketches defined by the enum.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.html#%3Cinit%3E()" class="member-name-link">SerializerDeserializer()</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a> - Enum Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#serializeToByteArray(java.lang.Boolean)" class="member-name-link">serializeToByteArray(Boolean)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#serializeToByteArray(java.lang.Boolean%5B%5D)" class="member-name-link">serializeToByteArray(Boolean[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#serializeToByteArray(java.lang.Double)" class="member-name-link">serializeToByteArray(Double)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#serializeToByteArray(java.lang.Double%5B%5D)" class="member-name-link">serializeToByteArray(Double[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#serializeToByteArray(java.lang.Long)" class="member-name-link">serializeToByteArray(Long)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#serializeToByteArray(java.lang.Long%5B%5D)" class="member-name-link">serializeToByteArray(Long[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#serializeToByteArray(java.lang.Number)" class="member-name-link">serializeToByteArray(Number)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#serializeToByteArray(java.lang.Number%5B%5D)" class="member-name-link">serializeToByteArray(Number[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#serializeToByteArray(java.lang.String)" class="member-name-link">serializeToByteArray(String)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#serializeToByteArray(java.lang.String)" class="member-name-link">serializeToByteArray(String)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#serializeToByteArray(java.lang.String%5B%5D)" class="member-name-link">serializeToByteArray(String[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#serializeToByteArray(java.lang.String%5B%5D)" class="member-name-link">serializeToByteArray(String[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#serializeToByteArray(T)" class="member-name-link">serializeToByteArray(T)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)" class="member-name-link">serializeToByteArray(T[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#serializeToString()" class="member-name-link">serializeToString()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns a String representation of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/AnotB.html#setA(org.apache.datasketches.theta.Sketch)" class="member-name-link">setA(Sketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></dt> +<dd> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/AnotB.html#setA(org.apache.datasketches.tuple.Sketch)" class="member-name-link">setA(Sketch<S>)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a></dt> +<dd> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#setClass(java.lang.Class)" class="member-name-link">setClass(Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt> +<dd> +<div class="block">Specifies the class to use when copying the item array from the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setFamily(org.apache.datasketches.common.Family)" class="member-name-link">setFamily(Family)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Set the Family.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#setHighRankAccuracy(boolean)" class="member-name-link">setHighRankAccuracy(boolean)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">This sets the parameter highRankAccuracy.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html#setK(int)" class="member-name-link">setK(int)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></dt> +<dd> +<div class="block">Sets the parameter <i>k</i> that determines the accuracy and size of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#setK(int)" class="member-name-link">setK(int)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">This sets the parameter k.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setLocalLogNominalEntries(int)" class="member-name-link">setLocalLogNominalEntries(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Alternative method of setting the Nominal Entries for a local concurrent sketch from the + log_base2 value.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setLocalNominalEntries(int)" class="member-name-link">setLocalNominalEntries(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the Nominal Entries for the concurrent local sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#setLogNominalEntries(int)" class="member-name-link">setLogNominalEntries(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Alternative method of setting the Nominal Entries for this set operation from the log_base2 value.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setLogNominalEntries(int)" class="member-name-link">setLogNominalEntries(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Alternative method of setting the Nominal Entries for this sketch from the log_base2 value.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setMaxConcurrencyError(double)" class="member-name-link">setMaxConcurrencyError(double)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the Maximum Concurrency Error.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html#setMaxK(int)" class="member-name-link">setMaxK(int)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></dt> +<dd> +<div class="block">Sets the parameter <i>masK</i> that determines the maximum size of the sketch that + results from a union and its accuracy.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setMaxNumLocalThreads(int)" class="member-name-link">setMaxNumLocalThreads(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the Maximum Number of Local Threads.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">setMemoryRequestServer(MemoryRequestServer)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Set the MemoryRequestServer</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">setMemoryRequestServer(MemoryRequestServer)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Set the MemoryRequestServer</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Sets the Maximum Nominal Entries (max K) for this set operation.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the Nominal Entries for this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries(int)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">This is to set the nominal number of entries.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries(int)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">This is to set the nominal number of entries.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries(int)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></dt> +<dd> +<div class="block">This is to set the nominal number of entries.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#setNumberOfValues(int)" class="member-name-link">setNumberOfValues(int)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">This is to set the number of double values associated with each key</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#setNumberOfValues(int)" class="member-name-link">setNumberOfValues(int)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">This is to set the number of double values associated with each key</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setNumPoolThreads(int)" class="member-name-link">setNumPoolThreads(int)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the number of pool threads used for background propagation in the concurrent sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html" class="type-name-link" title="class in org.apache.datasketches.theta">SetOperation</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">The parent API for all Set Operations</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#setOperationBuilder()" class="member-name-link">setOperationBuilder()</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html" class="type-name-link" title="class in org.apache.datasketches.theta">SetOperationBuilder</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">For building a new SetOperation.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#%3Cinit%3E()" class="member-name-link">SetOperationBuilder()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Constructor for building a new SetOperation.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a> - Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">Simplifies and speeds up set operations by resolving specific corner cases.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html#%3Cinit%3E()" class="member-name-link">SetOperationCornerCases()</a> - Constructor for class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a> - Enum Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">A not B actions</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a> - Enum Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">List of corner cases</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a> - Enum Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">Intersection actions</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a> - Enum Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">List of union actions</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#setP(float)" class="member-name-link">setP(float)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setP(float)" class="member-name-link">setP(float)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i></div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setPropagateOrderedCompact(boolean)" class="member-name-link">setPropagateOrderedCompact(boolean)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the Propagate Ordered Compact flag to the given value.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#setReqDebug(org.apache.datasketches.req.ReqDebug)" class="member-name-link">setReqDebug(ReqDebug)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> +<div class="block">This sets the parameter reqDebug.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor(ResizeFactor)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Sets the cache Resize Factor</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor(ResizeFactor)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the cache Resize Factor.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor(ResizeFactor)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">This is to set the resize factor.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor(ResizeFactor)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></dt> +<dd> +<div class="block">This is to set the resize factor.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#setSamplingProbability(float)" class="member-name-link">setSamplingProbability(float)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">This is to set sampling probability.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html#setSamplingProbability(float)" class="member-name-link">setSamplingProbability(float)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></dt> +<dd> +<div class="block">This is to set sampling probability.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#setSeed(long)" class="member-name-link">setSeed(long)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> +<div class="block">Sets the long seed value that is require by the hashing function.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#setSeed(long)" class="member-name-link">setSeed(long)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html#setSeed(long)" class="member-name-link">setSeed(long)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></dt> +<dd> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#setSeed(long)" class="member-name-link">setSeed(long)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></dt> +<dd> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/JaccardSimilarity.html#similarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)" class="member-name-link">similarityTest(Sketch, Sketch, double)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></dt> +<dd> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest(Sketch<S>, Sketch, S, SummarySetOperations<S>, double)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest(Sketch<S>, Sketch<S>, SummarySetOperations<S>, double)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></dt> +<dd> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#sizeOf(java.lang.Boolean)" class="member-name-link">sizeOf(Boolean)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#sizeOf(java.lang.Boolean%5B%5D)" class="member-name-link">sizeOf(Boolean[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#sizeOf(java.lang.Double)" class="member-name-link">sizeOf(Double)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#sizeOf(java.lang.Double%5B%5D)" class="member-name-link">sizeOf(Double[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#sizeOf(java.lang.Long)" class="member-name-link">sizeOf(Long)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#sizeOf(java.lang.Long%5B%5D)" class="member-name-link">sizeOf(Long[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#sizeOf(java.lang.Number)" class="member-name-link">sizeOf(Number)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#sizeOf(java.lang.Number%5B%5D)" class="member-name-link">sizeOf(Number[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#sizeOf(java.lang.String)" class="member-name-link">sizeOf(String)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#sizeOf(java.lang.String)" class="member-name-link">sizeOf(String)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf(Memory, long, int)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#sizeOf(T)" class="member-name-link">sizeOf(T)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)" class="member-name-link">sizeOf(T[])</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">Sketch</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">The top-level class for all theta sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="org/apache/datasketches/tuple/Sketch.html" title="type parameter in Sketch">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#SKETCH_A" class="member-name-link">SKETCH_A</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Sketch A Exact</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#SKETCH_A" class="member-name-link">SKETCH_A</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Sketch A Exactly</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#SKETCH_B" class="member-name-link">SKETCH_B</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Sketch B Exactly</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html" class="type-name-link" title="class in org.apache.datasketches.theta">Sketches</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">This class brings together the common sketch and set operation creation methods and + the public static methods into one place.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketches.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketches</a> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Convenient static methods to instantiate generic tuple sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketches.html#%3Cinit%3E()" class="member-name-link">Sketches()</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/SketchesArgumentException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesArgumentException</a> - Exception in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Illegal Arguments Exception class for the library</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesArgumentException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesArgumentException(String)</a> - Constructor for exception org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></dt> +<dd> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesException</a> - Exception in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Exception class for the library</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesException(String)</a> - Constructor for exception org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></dt> +<dd> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesException.html#%3Cinit%3E(java.lang.String,java.lang.Throwable)" class="member-name-link">SketchesException(String, Throwable)</a> - Constructor for exception org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></dt> +<dd> +<div class="block">Constructs a new runtime exception with the specified detail message and cause.</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesReadOnlyException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a> - Exception in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Write operation attempted on a read-only class.</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesReadOnlyException.html#%3Cinit%3E()" class="member-name-link">SketchesReadOnlyException()</a> - Constructor for exception org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></dt> +<dd> +<div class="block">Constructs a new runtime exception with the message: + "Write operation attempted on a read-only class."</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesReadOnlyException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesReadOnlyException(String)</a> - Constructor for exception org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></dt> +<dd> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesStateException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesStateException</a> - Exception in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Illegal State Exception class for the library</div> +</dd> +<dt><a href="org/apache/datasketches/common/SketchesStateException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesStateException(String)</a> - Constructor for exception org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesStateException.html" title="class in org.apache.datasketches.common">SketchesStateException</a></dt> +<dd> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/SketchFillRequest.html" class="type-name-link" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a>,<wbr><a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">S</a> extends <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a>> & <a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a>>> - Interface in <a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></dt> +<dd> +<div class="block">This is a callback request to the data source to fill a quantiles sketch, + which is returned to the caller.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This defines the methods required to compute the partition limits.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html#sketchStateId(boolean,int,long)" class="member-name-link">sketchStateId(boolean, int, long)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></dt> +<dd> +<div class="block">Returns the sketch state ID</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/Sort.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">Sort</a> - Class in <a href="org/apache/datasketches/tdigest/package-summary.html">org.apache.datasketches.tdigest</a></dt> +<dd> +<div class="block">Specialized sorting algorithm that can sort one array and permute another array the same way.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/Sort.html#%3Cinit%3E()" class="member-name-link">Sort()</a> - Constructor for class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/Sort.html" title="class in org.apache.datasketches.tdigest">Sort</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">SortedView</a> - Interface in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This is the base interface for the Sorted View interface hierarchy and defines the methods that are type independent.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt> +<dd> +<div class="block">This is the base interface for the SortedViewIterator hierarchy used with a SortedView obtained + from a quantile-type sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/Sort.html#stableSort(double%5B%5D,long%5B%5D,int)" class="member-name-link">stableSort(double[], long[], int)</a> - Static method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/Sort.html" title="class in org.apache.datasketches.tdigest">Sort</a></dt> +<dd> +<div class="block">Stable sort two arrays.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.StackElement.html#%3Cinit%3E(org.apache.datasketches.quantilescommon.GenericPartitionBoundaries,int,java.lang.String)" class="member-name-link">StackElement(GenericPartitionBoundaries<T>, int, String)</a> - Constructor for class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a></dt> +<dd> +<div class="block">Constructs this StackElement</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CompressionCharacterization.html#start()" class="member-name-link">start()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CompressionCharacterization.html" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a></dt> +<dd> +<div class="block">Only used in test</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/MergingValidation.html#start()" class="member-name-link">start()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/MergingValidation.html" title="class in org.apache.datasketches.cpc">MergingValidation</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/cpc/QuickMergingValidation.html#start()" class="member-name-link">start()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/QuickMergingValidation.html" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/cpc/StreamingValidation.html#start()" class="member-name-link">start()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/StreamingValidation.html" title="class in org.apache.datasketches.cpc">StreamingValidation</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html#startingSubMultiple(int,int,int)" class="member-name-link">startingSubMultiple(int, int, int)</a> - Static method in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></dt> +<dd> +<div class="block">Gets the smallest allowed exponent of 2 that it is a sub-multiple of the target by zero, + one or more resize factors.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/StreamingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">StreamingValidation</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/StreamingValidation.html#%3Cinit%3E(int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">StreamingValidation(int, int, int, int, PrintStream, PrintWriter)</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/StreamingValidation.html" title="class in org.apache.datasketches.cpc">StreamingValidation</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/thetacommon/HashOperations.html#STRIDE_MASK" class="member-name-link">STRIDE_MASK</a> - Static variable in class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></dt> +<dd> +<div class="block">The stride mask for the Open Address, Double Hashing (OADH) hash table algorithm.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#stringArrHash(java.lang.String%5B%5D)" class="member-name-link">stringArrHash(String[])</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#stringConcat(java.lang.String%5B%5D)" class="member-name-link">stringConcat(String[])</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Concatenate array of Strings to a single String.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#stringHash(java.lang.String)" class="member-name-link">stringHash(String)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#stringToByteArray(java.lang.String)" class="member-name-link">stringToByteArray(String)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> +<div class="block">Converts a String to a UTF_8 byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#stringToFamily(java.lang.String)" class="member-name-link">stringToFamily(String)</a> - Static method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns the Family given the family name</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#suggestNumFilterBits(long,double)" class="member-name-link">suggestNumFilterBits(long, double)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Returns the optimal number of bits to use in a Bloom Filter given a target number of distinct + items and a target false positive probability.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#suggestNumHashes(double)" class="member-name-link">suggestNumHashes(double)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Returns the optimal number of hash functions to achieve a target false positive probability.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html#suggestNumHashes(long,long)" class="member-name-link">suggestNumHashes(long, long)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></dt> +<dd> +<div class="block">Returns the optimal number of hash functions to given target numbers of distinct items + and the BloomFilter size in bits.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html#Sum" class="member-name-link">Sum</a> - Enum constant in enum class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is the summation function.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html#Sum" class="member-name-link">Sum</a> - Enum constant in enum class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></dt> +<dd> +<div class="block">The aggregation mode is the summation function.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Summary.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">Summary</a> - Interface in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SummaryDeserializer.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="type parameter in SummaryDeserializer">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Interface in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Interface for deserializing user-defined Summary</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SummaryFactory.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="org/apache/datasketches/tuple/SummaryFactory.html" title="type parameter in SummaryFactory">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Interface in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Interface for user-defined SummaryFactory</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SummarySetOperations.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Interface in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</dd> +<dt><a href="org/apache/datasketches/common/SuppressFBWarnings.html" class="type-name-link" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> - Annotation Interface in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Used to suppress SpotBug warnings.</div> +</dd> +</dl> +<h2 class="title" id="I:T">T</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Util.html#TAB" class="member-name-link">TAB</a> - Static variable in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">The tab character</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#tailRoundingFactor" class="member-name-link">tailRoundingFactor</a> - Static variable in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt> +<dd> +<div class="block">used in search to improve rounding over a wide dynamic range</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#TDIGEST" class="member-name-link">TDIGEST</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">t-Digest for estimating quantiles and ranks</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">TDigestDouble</a> - Class in <a href="org/apache/datasketches/tdigest/package-summary.html">org.apache.datasketches.tdigest</a></dt> +<dd> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#%3Cinit%3E()" class="member-name-link">TDigestDouble()</a> - Constructor for class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Constructor with the default K</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#%3Cinit%3E(short)" class="member-name-link">TDigestDouble(short)</a> - Constructor for class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Constructor</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/TestUtil.html" class="type-name-link" title="class in org.apache.datasketches.cpc">TestUtil</a> - Class in <a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/cpc/TestUtil.html#%3Cinit%3E()" class="member-name-link">TestUtil()</a> - Constructor for class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/TestUtil.html" title="class in org.apache.datasketches.cpc">TestUtil</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG" class="member-name-link">TGT_IS_READ_ONLY_MSG</a> - Static variable in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Target sketch is Read Only, cannot write.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/TgtHllType.html" class="type-name-link" title="enum class in org.apache.datasketches.hll">TgtHllType</a> - Enum Class in <a href="org/apache/datasketches/hll/package-summary.html">org.apache.datasketches.hll</a></dt> +<dd> +<div class="block">Specifies the target type of HLL sketch to be created.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/ThetaUtil.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a> - Class in <a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></dt> +<dd> +<div class="block">Utility methods for the Theta Family of sketches</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return this sketch as a compressed byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Serializes the current BloomFilter to an array of bytes.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Export the current sketch as a compact byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Serialize this union to a byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Returns a byte array representation of this union</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Serialize this TDigest to a byte array form.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Intersection.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></dt> +<dd> +<div class="block">Serialize this intersection to a byte array form.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Serialize this sketch to a byte array form.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Returns a byte array image of this Union object</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/CompactSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</div> +</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> +<div class="block">This is to serialize a sketch instance to a byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Summary.html#toByteArray()" class="member-name-link">toByteArray()</a> - Method in interface org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></dt> +<dd> +<div class="block">This is to serialize a Summary instance to a byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#toByteArray(boolean)" class="member-name-link">toByteArray(boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Serialize this sketch in a byte array form.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#toByteArray(boolean,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(boolean, ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Serialize this sketch to a byte array form.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<? super T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<? super T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<? super T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<? super T>, Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<? super T>, Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<? super T>, Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns a byte array representation of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Serialize this sketch to a byte array form.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Serialize this union to a byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Returns a byte array representation of this union</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Returns a byte array representation of this union</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<T>, Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Returns a byte array representation of this union.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray(ArrayOfItemsSerDe<T>, Class<?>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Returns a byte array representation of this union.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#toByteArrayCompressed()" class="member-name-link">toByteArrayCompressed()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> +<div class="block">gets the sketch as a compressed byte array</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#toCompactByteArray()" class="member-name-link">toCompactByteArray()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#toCompactByteArray()" class="member-name-link">toCompactByteArray()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Gets the serialization of this union operator as a byte array in compact form, which is + designed to be heapified only.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#toLongArray()" class="member-name-link">toLongArray()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Serializes the current BloomFilter to an array of longs.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#toString()" class="member-name-link">toString()</a> - Method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return a human-readable string summary of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/Group.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable summary of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns a human readable summary of this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Human readable summary as a string.</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Returns a string with a human-readable summary of the UniqueCountMap and all the internal maps</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns human readable summary information about this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></dt> +<dd> +<div class="block">Creates a human readable string that describes the current configuration of this builder.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns summary information about the backing sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Returns human readable summary information about this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Returns summary information about the backing sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#toString()" class="member-name-link">toString()</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Returns a summary of the key parameters of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/req/ReqSketchBuilder.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Provides a human-readable summary of the sketch</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns a human-readable summary of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Human-readable summary of this TDigest as a string</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperationBuilder.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns a human readable summary of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/Sketch.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#toString(boolean)" class="member-name-link">toString(boolean)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Return a human-readable string summary of this sketch</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#toString(boolean)" class="member-name-link">toString(boolean)</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Human-readable summary of this TDigest as a string</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dt> +<dd> +<div class="block">Returns human readable summary information about this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns human readable summary information about this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns summary information about the backing sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Returns human readable summary information about this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#toString(boolean,boolean)" class="member-name-link">toString(boolean, boolean)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Returns summary information about the backing sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#toString(boolean,boolean,boolean)" class="member-name-link">toString(boolean, boolean, boolean)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Human readable summary with optional detail.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#toString(boolean,boolean,boolean,boolean)" class="member-name-link">toString(boolean, boolean, boolean, boolean)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#toString(boolean,boolean,boolean,boolean)" class="member-name-link">toString(boolean, boolean, boolean, boolean)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#toString(boolean,boolean,int,boolean)" class="member-name-link">toString(boolean, boolean, int, boolean)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Gets a human readable listing of contents and summary of the given sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a LongsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of an HllSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a DoublesSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of an ItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ReservoirItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ReservoirLongsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a VarOptItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#toString(byte%5B%5D)" class="member-name-link">toString(byte[])</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a Theta Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#toString(byte%5B%5D,boolean)" class="member-name-link">toString(byte[], boolean)</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a byte array image of a CpcSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html#toString(java.lang.Boolean)" class="member-name-link">toString(Boolean)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html#toString(java.lang.Double)" class="member-name-link">toString(Double)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html#toString(java.lang.Long)" class="member-name-link">toString(Long)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html#toString(java.lang.Number)" class="member-name-link">toString(Number)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html#toString(java.lang.String)" class="member-name-link">toString(String)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html#toString(java.lang.String)" class="member-name-link">toString(String)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a LongsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of an HllSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a DoublesSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of an ItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ReservoirItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ReservoirLongsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a VarOptItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a Theta Sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#toString(org.apache.datasketches.memory.Memory,boolean)" class="member-name-link">toString(Memory, boolean)</a> - Static method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Returns a human readable string of the preamble of a Memory image of a CpcSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html#toString(T)" class="member-name-link">toString(T)</a> - Method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></dt> +<dd> +<div class="block">Returns a human readable string of an item.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#toUpdatableByteArray()" class="member-name-link">toUpdatableByteArray()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#toUpdatableByteArray()" class="member-name-link">toUpdatableByteArray()</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#trim()" class="member-name-link">trim()</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#trim()" class="member-name-link">trim()</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#TRIM_A" class="member-name-link">TRIM_A</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Trim Sketch A by MinTheta</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#TRIM_A" class="member-name-link">TRIM_A</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Trim Sketch A by MinTheta</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#TRIM_B" class="member-name-link">TRIM_B</a> - Enum constant in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Trim Sketch B by MinTheta</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#TUPLE" class="member-name-link">TUPLE</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Tuple family of sketches is a large family of sketches that are extensions of the + Theta Sketch Framework.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/TupleSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="org/apache/datasketches/tuple/TupleSketchIterator.html" title="type parameter in TupleSketchIterator">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Iterator over a generic tuple sketch</div> +</dd> +</dl> +<h2 class="title" id="I:U">U</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#union(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">union(BloomFilter)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Unions two BloomFilters by applying a logical OR.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#union(org.apache.datasketches.memory.Memory)" class="member-name-link">union(Memory)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#union(org.apache.datasketches.memory.Memory)" class="member-name-link">union(Memory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Perform a Union operation with <i>this</i> union and the given Memory image of any sketch of the + Theta Family.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#union(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">union(Memory, ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#union(org.apache.datasketches.quantiles.DoublesSketch)" class="member-name-link">union(DoublesSketch)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#union(org.apache.datasketches.quantiles.ItemsSketch)" class="member-name-link">union(ItemsSketch<T>)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#union(org.apache.datasketches.theta.Sketch)" class="member-name-link">union(Sketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Perform a Union operation with <i>this</i> union and the given on-heap sketch of the Theta Family.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">union(Sketch, Sketch)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">union(Sketch, Sketch, boolean, WritableMemory)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#union(org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union(Sketch, S)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Performs a stateful union of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html#union(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">union(DoubleSummary, DoubleSummary)</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html#union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">union(IntegerSummary, IntegerSummary)</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#union(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">union(ArrayOfDoublesSketch)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Updates the union by adding a set of entries from a given sketch, which can be on-heap or off-heap.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#union(org.apache.datasketches.tuple.Sketch)" class="member-name-link">union(Sketch<S>)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Performs a stateful union of the internal set with the given tupleSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union(Sketch<S>, Sketch, S)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">union(Sketch<S>, Sketch<S>)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Perform a stateless, pair-wise union operation between two tuple sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html#union(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">union(ArrayOfStringsSummary, ArrayOfStringsSummary)</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/SummarySetOperations.html#union(S,S)" class="member-name-link">union(S, S)</a> - Method in interface org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></dt> +<dd> +<div class="block">This is called by the union operator when both sketches have the same hash value.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html" class="type-name-link" title="class in org.apache.datasketches.hll">Union</a> - Class in <a href="org/apache/datasketches/hll/package-summary.html">org.apache.datasketches.hll</a></dt> +<dd> +<div class="block">This performs union operations for all HllSketches.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html" class="type-name-link" title="class in org.apache.datasketches.theta">Union</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">Compute the union of two or more theta sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Union</a><<a href="org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with + theta sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#%3Cinit%3E()" class="member-name-link">Union()</a> - Constructor for class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Construct this Union operator with the default maximum log-base-2 of <i>K</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#%3Cinit%3E()" class="member-name-link">Union()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/hll/Union.html#%3Cinit%3E(int)" class="member-name-link">Union(int)</a> - Constructor for class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Construct this Union operator with a given maximum log-base-2 of <i>K</i>.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#%3Cinit%3E(int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">Union(int, WritableMemory)</a> - Constructor for class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Construct this Union operator with a given maximum log-base-2 of <i>K</i> and the given + WritableMemory as the destination for this Union.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#%3Cinit%3E(int,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Union(int, SummarySetOperations<S>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Creates new Union instance.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Union.html#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Union(SummarySetOperations<S>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a></dt> +<dd> +<div class="block">Creates new Union instance with instructions on how to process two summaries that + overlap.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#UNION" class="member-name-link">UNION</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The Union family is an operation for the Theta Sketch Framework of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html" class="type-name-link" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a> - Class in <a href="org/apache/datasketches/hllmap/package-summary.html">org.apache.datasketches.hllmap</a></dt> +<dd> +<div class="block">This is a real-time, key-value HLL mapping sketch that tracks approximate unique counts of + identifiers (the values) associated with each key.</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#%3Cinit%3E(int)" class="member-name-link">UniqueCountMap(int)</a> - Constructor for class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Constructs a UniqueCountMap with an initial capacity of one million entries.</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#%3Cinit%3E(int,int)" class="member-name-link">UniqueCountMap(int, int)</a> - Constructor for class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Constructs a UniqueCountMap with a given initial number of entries.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/BitPacking.html#unpackBits(long%5B%5D,int,int,byte%5B%5D,int,int)" class="member-name-link">unpackBits(long[], int, int, byte[], int, int)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/BitPacking.html" title="class in org.apache.datasketches.theta">BitPacking</a></dt> +<dd> +<div class="block">The unpacking operation</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG" class="member-name-link">UNSUPPORTED_MSG</a> - Static variable in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dt> +<dd> +<div class="block">Unsupported operation for this Sketch Type.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#UPDATABLE" class="member-name-link">UPDATABLE</a> - Enum constant in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">Updatable Preamble Structure</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a> extends <a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketch(int, int, float, SummaryFactory<S>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">This is to create a new instance of an UpdatableQuickSelectSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketch(Memory, SummaryDeserializer<S>, SummaryFactory<S>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#%3Cinit%3E(org.apache.datasketches.tuple.UpdatableSketch)" class="member-name-link">UpdatableSketch(UpdatableSketch<U, S>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Copy Constructor</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a> extends <a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>>> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">For building a new generic tuple UpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html#%3Cinit%3E(org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketchBuilder(SummaryFactory<S>)</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></dt> +<dd> +<div class="block">Creates an instance of UpdatableSketchBuilder with default parameters</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSummary.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a>> - Interface in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Interface for updating user-defined Summary</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(byte%5B%5D)" class="member-name-link">update(byte[])</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given byte array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(byte%5B%5D)" class="member-name-link">update(byte[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided byte[].</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(byte%5B%5D)" class="member-name-link">update(byte[])</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given byte array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(byte%5B%5D)" class="member-name-link">update(byte[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the given byte array item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(byte%5B%5D)" class="member-name-link">update(byte[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with the given byte array.</div> +</dd> +<dt><a href="org/apache/datasketches/hllmap/UniqueCountMap.html#update(byte%5B%5D,byte%5B%5D)" class="member-name-link">update(byte[], byte[])</a> - Method in class org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></dt> +<dd> +<div class="block">Updates the map with a given key and identifier and returns the estimate of the number of + unique identifiers encountered so far for the given key.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#update(byte%5B%5D,double%5B%5D)" class="member-name-link">update(byte[], double[])</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a byte[] key and double values.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#update(byte%5B%5D,U)" class="member-name-link">update(byte[], U)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a byte[] key and U value.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(char%5B%5D)" class="member-name-link">update(char[])</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given char array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(char%5B%5D)" class="member-name-link">update(char[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided char[].</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(char%5B%5D)" class="member-name-link">update(char[])</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given char array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(char%5B%5D)" class="member-name-link">update(char[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the given char array item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(char%5B%5D)" class="member-name-link">update(char[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with the given char array.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given double (or float) datum as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided double value.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given double (or float) datum as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Update this union with the given double (or float) data Item.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></dt> +<dd> +<div class="block">Updates this sketch with the given double data item</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#update(double)" class="member-name-link">update(double)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt> +<dd> +<div class="block">Updates this sketch with the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/tdigest/TDigestDouble.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></dt> +<dd> +<div class="block">Update this TDigest with the given value</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the given double (or float) data item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with the given double (or float) datum.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#update(double%5B%5D,int,int)" class="member-name-link">update(double[], int, int)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Vector update.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#update(double,double%5B%5D)" class="member-name-link">update(double, double[])</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a double key and double values.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#update(double,long)" class="member-name-link">update(double, long)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Weighted update.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#update(double,U)" class="member-name-link">update(double, U)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a double key and U value.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#update(float)" class="member-name-link">update(float)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html#update(float)" class="member-name-link">update(float)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></dt> +<dd> +<div class="block">Updates this sketch with the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#update(float)" class="member-name-link">update(float)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#update(float%5B%5D,int,int)" class="member-name-link">update(float[], int, int)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Vector update.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#update(float,long)" class="member-name-link">update(float, long)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Weighted update.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(int%5B%5D)" class="member-name-link">update(int[])</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given integer array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(int%5B%5D)" class="member-name-link">update(int[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided int[].</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(int%5B%5D)" class="member-name-link">update(int[])</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given integer array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(int%5B%5D)" class="member-name-link">update(int[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the given integer array item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(int%5B%5D)" class="member-name-link">update(int[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with the given integer array.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#update(int%5B%5D,double%5B%5D)" class="member-name-link">update(int[], double[])</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a int[] key and double values.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#update(int%5B%5D,U)" class="member-name-link">update(int[], U)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a int[] key and U value.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given long as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided long value.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Update this sketch with an item and a frequency count of one.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given long as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html#update(long)" class="member-name-link">update(long)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></dt> +<dd> +<div class="block">Updates this sketch with the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></dt> +<dd> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Present this union with a long.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the given long data item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(long)" class="member-name-link">update(long)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with a long.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(long%5B%5D)" class="member-name-link">update(long[])</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given long array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(long%5B%5D)" class="member-name-link">update(long[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided long[].</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(long%5B%5D)" class="member-name-link">update(long[])</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given long array as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(long%5B%5D)" class="member-name-link">update(long[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the given long array item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(long%5B%5D)" class="member-name-link">update(long[])</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with the given long array.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#update(long%5B%5D,double%5B%5D)" class="member-name-link">update(long[], double[])</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a long[] key and double values.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#update(long%5B%5D,int,int)" class="member-name-link">update(long[], int, int)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Vector update.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#update(long%5B%5D,U)" class="member-name-link">update(long[], U)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a long[] key and U value.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#update(long,double%5B%5D)" class="member-name-link">update(long, double[])</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a long key and double values.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#update(long,int,java.util.ArrayList)" class="member-name-link">update(long, int, ArrayList<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Present this union with raw elements of a sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/LongsSketch.html#update(long,long)" class="member-name-link">update(long, long)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dt> +<dd> +<div class="block">Update this sketch with a item and a positive frequency count (or weight).</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#update(long,long)" class="member-name-link">update(long, long)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Weighted update.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html#update(long,java.lang.Double)" class="member-name-link">update(long, Double)</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html#update(long,java.lang.Integer)" class="member-name-link">update(long, Integer)</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#update(long,U)" class="member-name-link">update(long, U)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a long key and U value.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(short%5B%5D)" class="member-name-link">update(short[])</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided short[].</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html#update(java.lang.Double)" class="member-name-link">update(Double)</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html#update(java.lang.Integer)" class="member-name-link">update(Integer)</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(java.lang.String)" class="member-name-link">update(String)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given String as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(java.lang.String)" class="member-name-link">update(String)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the provided String.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(java.lang.String)" class="member-name-link">update(String)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given String as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(java.lang.String)" class="member-name-link">update(String)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the with the given String data item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(java.lang.String)" class="member-name-link">update(String)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with the given String.</div> +</dd> +<dt><a href="org/apache/datasketches/fdt/FdtSketch.html#update(java.lang.String%5B%5D)" class="member-name-link">update(String[])</a> - Method in class org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></dt> +<dd> +<div class="block">Update the sketch with the given string array tuple.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html#update(java.lang.String%5B%5D)" class="member-name-link">update(String[])</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#update(java.lang.String%5B%5D,java.lang.String%5B%5D)" class="member-name-link">update(String[], String[])</a> - Method in class org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></dt> +<dd> +<div class="block">Updates the sketch with String arrays for both key and value.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#update(java.lang.String,double%5B%5D)" class="member-name-link">update(String, double[])</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a String key and double values.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html#update(java.lang.String,java.lang.Double)" class="member-name-link">update(String, Double)</a> - Method in class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html#update(java.lang.String,java.lang.Integer)" class="member-name-link">update(String, Integer)</a> - Method in class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#update(java.lang.String,U)" class="member-name-link">update(String, U)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a String key and U value.</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#update(java.nio.ByteBuffer)" class="member-name-link">update(ByteBuffer)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Present the given ByteBuffer as a potential unique item + If the ByteBuffer is null or empty no update attempt is made and the method returns</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#update(java.nio.ByteBuffer)" class="member-name-link">update(ByteBuffer)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Present the given byte buffer as a potential unique item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Union.html#update(java.nio.ByteBuffer)" class="member-name-link">update(ByteBuffer)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></dt> +<dd> +<div class="block">Update <i>this</i> union with the given ByteBuffer item.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#update(java.nio.ByteBuffer)" class="member-name-link">update(ByteBuffer)</a> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Present this sketch with the given ByteBuffer + If the ByteBuffer is null or empty, no update attempt is made and the method returns.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#update(java.nio.ByteBuffer,double%5B%5D)" class="member-name-link">update(ByteBuffer, double[])</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a ByteBuffer key and double values.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSketch.html#update(java.nio.ByteBuffer,U)" class="member-name-link">update(ByteBuffer, U)</a> - Method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></dt> +<dd> +<div class="block">Updates this sketch with a ByteBuffer and U value + The value is passed to the update() method of the Summary object associated with the key</div> +</dd> +<dt><a href="org/apache/datasketches/cpc/CpcUnion.html#update(org.apache.datasketches.cpc.CpcSketch)" class="member-name-link">update(CpcSketch)</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></dt> +<dd> +<div class="block">Update this union with a CpcSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#update(org.apache.datasketches.hll.HllSketch)" class="member-name-link">update(HllSketch)</a> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Update this union operator with the given sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#update(org.apache.datasketches.memory.Memory)" class="member-name-link">update(Memory)</a> - Method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Updates the filter with the data in the provided Memory.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#update(org.apache.datasketches.memory.Memory)" class="member-name-link">update(Memory)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Union the given Memory image of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">update(Memory, ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Union the given Memory image of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">update(Memory, ArrayOfItemsSerDe<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Union the given Memory image of the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#update(org.apache.datasketches.sampling.ReservoirItemsSketch)" class="member-name-link">update(ReservoirItemsSketch<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Union the given sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#update(org.apache.datasketches.sampling.ReservoirItemsSketch)" class="member-name-link">update(ReservoirItemsSketch<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Union a reservoir sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html#update(org.apache.datasketches.sampling.ReservoirLongsSketch)" class="member-name-link">update(ReservoirLongsSketch)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></dt> +<dd> +<div class="block">Union the given sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html#update(org.apache.datasketches.sampling.VarOptItemsSketch)" class="member-name-link">update(VarOptItemsSketch<T>)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></dt> +<dd> +<div class="block">Union the given sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">update(ArrayOfDoublesSketch, ArrayOfDoublesSketch)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></dt> +<dd> +<div class="block">Perform A-and-not-B set operation on the two given sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">update(ArrayOfDoublesSketch, ArrayOfDoublesSketch)</a> - Method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#update(T)" class="member-name-link">update(T)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Update this sketch with an item and a frequency count of one.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#update(T)" class="member-name-link">update(T)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsSketch.html#update(T)" class="member-name-link">update(T)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/quantiles/ItemsUnion.html#update(T)" class="member-name-link">update(T)</a> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></dt> +<dd> +<div class="block">Update this union with the given dataItem.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#update(T)" class="member-name-link">update(T)</a> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt> +<dd> +<div class="block">Updates this sketch with the given item.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#update(T)" class="member-name-link">update(T)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Updates this sketch with the given data item with weight 1.0.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#update(T)" class="member-name-link">update(T)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt> +<dd> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html#update(T)" class="member-name-link">update(T)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></dt> +<dd> +<div class="block">Present this union with a single item to be added to the union.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#update(T,double)" class="member-name-link">update(T, double)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt> +<dd> +<div class="block">Updates this sketch with the given data item with the given weight.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html#update(T,double)" class="member-name-link">update(T, double)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></dt> +<dd> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ItemsSketch.html#update(T,long)" class="member-name-link">update(T, long)</a> - Method in class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></dt> +<dd> +<div class="block">Update this sketch with an item and a positive frequency count.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#update(T,long)" class="member-name-link">update(T, long)</a> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Weighted update.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/UpdatableSummary.html#update(U)" class="member-name-link">update(U)</a> - Method in interface org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></dt> +<dd> +<div class="block">This is to provide a method of updating summaries.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a> - Class in <a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></dt> +<dd> </dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html" class="type-name-link" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a> - Enum Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block"><a href="./resources/dictionary.html#updateReturnState">See Update Return State</a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketch</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#updateSketchBuilder()" class="member-name-link">updateSketchBuilder()</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a> - Class in <a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></dt> +<dd> +<div class="block">For building a new UpdateSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#%3Cinit%3E()" class="member-name-link">UpdateSketchBuilder()</a> - Constructor for class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt> +<dd> +<div class="block">Constructor for building a new UpdateSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html#upperBound" class="member-name-link">upperBound</a> - Variable in class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></dt> +<dd> +<div class="block">The upper bound value</div> +</dd> +<dt><a href="org/apache/datasketches/common/Util.html" class="type-name-link" title="class in org.apache.datasketches.common">Util</a> - Class in <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></dt> +<dd> +<div class="block">Common utility functions.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Util</a> - Class in <a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></dt> +<dd> +<div class="block">Common utility functions for Tuples</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/Util.html#%3Cinit%3E()" class="member-name-link">Util()</a> - Constructor for class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></dt> +<dd> </dd> +</dl> +<h2 class="title" id="I:V">V</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/cpc/CpcSketch.html#validate()" class="member-name-link">validate()</a> - Method in class org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></dt> +<dd> +<div class="block">Convience function that this Sketch is valid.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.html#validateFamily(byte,byte)" class="member-name-link">validateFamily(byte, byte)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></dt> +<dd> +<div class="block">Validates the preamble-Longs value given the family ID</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericSortedView.html#validateItems(T%5B%5D,java.util.Comparator)" class="member-name-link">validateItems(T[], Comparator<? super T>)</a> - Static method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></dt> +<dd> +<div class="block">Checks the sequential validity of the given array of generic items.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.html#validateType(byte,org.apache.datasketches.tuple.SerializerDeserializer.SketchType)" class="member-name-link">validateType(byte, SerializerDeserializer.SketchType)</a> - Static method in class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></dt> +<dd> +<div class="block">Validates the sketch type byte versus the expected value</div> +</dd> +<dt><a href="org/apache/datasketches/common/SuppressFBWarnings.html#value()" class="member-name-link">value()</a> - Element in annotation interface org.apache.datasketches.common.<a href="org/apache/datasketches/common/SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></dt> +<dd> +<div class="block">A list of comma-separated, quoted SpotBugs warnings that are to be suppressed in the associated + annotated element.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ErrorType.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/TgtHllType.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/BoundsRule.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></dt> +<dd> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/frequencies/ErrorType.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/TgtHllType.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/partitions/BoundsRule.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/InequalitySearch.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateReturnState.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html#values()" class="member-name-link">values()</a> - Static method in enum class org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#VAROPT" class="member-name-link">VAROPT</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The VarOpt family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/common/Family.html#VAROPT_UNION" class="member-name-link">VAROPT_UNION</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></dt> +<dd> +<div class="block">The VarOpt family of sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">This class provides access to the samples contained in a VarOptItemsSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.VarOptItemsIterator</a> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">The standard iterator</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">A convenience class to allow easy iterator access to a VarOpt sample.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">This sketch provides a variance optimal sample over an input stream of weighted items.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> - Class in <a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></dt> +<dd> +<div class="block">Provides a unioning operation over varopt sketches.</div> +</dd> +<dt><a href="org/apache/datasketches/req/ReqSketch.html#viewCompactorDetail(java.lang.String,boolean)" class="member-name-link">viewCompactorDetail(String, boolean)</a> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt> +<dd> </dd> +</dl> +<h2 class="title" id="I:W">W</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#weights()" class="member-name-link">weights()</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt> +<dd> +<div class="block">Returns a copy of the array of weights contained in the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#weights(int)" class="member-name-link">weights(int)</a> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt> +<dd> +<div class="block">Returns a single weight from the samples contained in the sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Wraps the given Memory into this filter class.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Wraps the given read-only Memory that must be a image of a valid sketch, + which may be in compact or updatable form, and should have data.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></dt> +<dd> +<div class="block">Wrap this sketch around the given Memory image of a DoublesSketch, compact or updatable.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns a read-only Union object that wraps off-heap data of the given memory image of + a sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> +<div class="block">Wrap takes the CompactSketch image in given Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/theta/CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt> +<dd> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt> +<dd> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></dt> +<dd> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllItemsSketch.html#wrap(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">wrap(Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt> +<dd> +<div class="block">Constructs a thin wrapper on the heap around a Memory (or WritableMemory) already initialized with a + validated sketch image of a type T consistent with the given comparator and serDe.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/DoublesUnion.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap(WritableMemory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt> +<dd> +<div class="block">Returns an updatable Union object that wraps off-heap data of the given memory image of + a sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap(WritableMemory)</a> - Static method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></dt> +<dd> +<div class="block">Wrap this sketch around the given non-compact Memory image of a DoublesSketch.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap(WritableMemory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap(WritableMemory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap(WritableMemory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap(WritableMemory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap(WritableMemory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></dt> +<dd> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/theta/UpdateSketch.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap(WritableMemory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dt> +<dd> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap(WritableMemory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></dt> +<dd> +<div class="block">Wrap the given WritableMemory and seed as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap(WritableMemory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dt> +<dd> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapCompactSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapCompactSketch(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapCompactSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapCompactSketch(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapIntersection(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapIntersection(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Convenience method, calls <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapIntersection(WritableMemory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Convenience method, calls <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapSetOperation(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSetOperation(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapSetOperation(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSetOperation(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapSetOperation(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapSetOperation(WritableMemory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapSetOperation(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapSetOperation(WritableMemory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSketch(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSketch(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSketch(Memory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSketch(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapUnion(Memory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Convenience method, calls <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapUnion(Memory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapUnion(Memory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUnion(WritableMemory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Convenience method, calls <a href="org/apache/datasketches/theta/SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUnion(WritableMemory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUnion(WritableMemory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUpdatableSketch(WritableMemory)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html#wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUpdatableSketch(WritableMemory, long)</a> - Static method in class org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></dt> +<dd> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUpdateSketch(WritableMemory)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/theta/Sketches.html#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUpdateSketch(WritableMemory, long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt> +<dd> +<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a></div> +</dd> +<dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap(WritableMemory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt> +<dd> +<div class="block">Wraps the given WritableMemory into this filter class.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/HllSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap(WritableMemory)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></dt> +<dd> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable sketch, + and may have data.</div> +</dd> +<dt><a href="org/apache/datasketches/hll/Union.html#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap(WritableMemory)</a> - Static method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt> +<dd> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable HLL_8 sketch, + and may have data.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllDoublesSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap(WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt> +<dd> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllFloatsSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap(WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></dt> +<dd> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</dd> +<dt><a href="org/apache/datasketches/kll/KllLongsSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap(WritableMemory, MemoryRequestServer)</a> - Static method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></dt> +<dd> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</dd> +</dl> +<h2 class="title" id="I:X">X</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#X1" class="member-name-link">X1</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Do not resize.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#X2" class="member-name-link">X2</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Resize factor is 2.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#X4" class="member-name-link">X4</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Resize factor is 4.</div> +</dd> +<dt><a href="org/apache/datasketches/common/ResizeFactor.html#X8" class="member-name-link">X8</a> - Enum constant in enum class org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></dt> +<dd> +<div class="block">Resize factor is 8.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/XxHash.html" class="type-name-link" title="class in org.apache.datasketches.hash">XxHash</a> - Class in <a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a></dt> +<dd> +<div class="block">The XxHash is a fast, non-cryptographic, 64-bit hash function that has + excellent avalanche and 2-way bit independence properties.</div> +</dd> +<dt><a href="org/apache/datasketches/hash/XxHash.html#%3Cinit%3E()" class="member-name-link">XxHash()</a> - Constructor for class org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/XxHash.html" title="class in org.apache.datasketches.hash">XxHash</a></dt> +<dd> </dd> +</dl> +<h2 class="title" id="I:Z">Z</h2> +<dl class="index"> +<dt><a href="org/apache/datasketches/common/Util.html#zeroPad(java.lang.String,int)" class="member-name-link">zeroPad(String, int)</a> - Static method in class org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" title="class in org.apache.datasketches.common">Util</a></dt> +<dd> +<div class="block">Prepend the given string with zeros.</div> +</dd> +</dl> +<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:K">K</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a href="#I:X">X</a> <a href="#I:Z">Z</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized Form</a></main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/index.html b/docs/7.0.X/index.html new file mode 100644 index 000000000..f879c9f9e --- /dev/null +++ b/docs/7.0.X/index.html @@ -0,0 +1,189 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Overview (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="package index"> +<meta name="generator" content="javadoc/PackageIndexWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-index-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li class="nav-bar-cell1-rev">Overview</li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-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#overview">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">datasketches-java 7.0.0 API</h1> +</div> +<div class="block"><h1>Sketching Core Library</h1> +<h2>Overview</h2> + +<p>The Sketching Core Library provides a range of stochastic streaming algorithms and closely + related java technologies that are particularly useful when integrating this technology into + systems that must deal with massive data. +</p> + +<p>This library is divided into packages that constitute distinct groups of functionality:</p> + +Note: In general, if the requirements or promises of any method's contract are not fulfilled +(that is, if there is a bug in either the method or its caller), +then an unchecked exception will be thrown. +The precise type of such an unchecked exception does not form part of any method's contract.</div> +<div id="all-packages-table"> +<div class="caption"><span>Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/filters/package-summary.html">org.apache.datasketches.filters</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">The filters package contains data structures used to determine + approximate set-membership.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/filters/bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">BloomFilter package</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">The hash package contains a high-performing and extended Java implementations + of Austin Appleby's 128-bit MurmurHash3 hash function originally coded in C.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/hll/package-summary.html">org.apache.datasketches.hll</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">The DataSketches™ HLL sketch family package</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/hllmap/package-summary.html">org.apache.datasketches.hllmap</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">The hllmap package contains a space efficient HLL mapping sketch of keys to approximate unique + count of identifiers.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> </div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tdigest/package-summary.html">org.apache.datasketches.tdigest</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="./resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +</div> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/jquery-ui.overrides.css b/docs/7.0.X/jquery-ui.overrides.css new file mode 100644 index 000000000..facf852c2 --- /dev/null +++ b/docs/7.0.X/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/docs/7.0.X/legal/ADDITIONAL_LICENSE_INFO b/docs/7.0.X/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 000000000..ff700cd09 --- /dev/null +++ b/docs/7.0.X/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/docs/7.0.X/legal/ASSEMBLY_EXCEPTION b/docs/7.0.X/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 000000000..065b8d902 --- /dev/null +++ b/docs/7.0.X/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU +General Public License <http://www.gnu.org/copyleft/gpl.html> version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + http://openjdk.java.net/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/docs/7.0.X/legal/LICENSE b/docs/7.0.X/legal/LICENSE new file mode 100644 index 000000000..8b400c7ab --- /dev/null +++ b/docs/7.0.X/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/docs/7.0.X/legal/jquery.md b/docs/7.0.X/legal/jquery.md new file mode 100644 index 000000000..a763ec6f1 --- /dev/null +++ b/docs/7.0.X/legal/jquery.md @@ -0,0 +1,26 @@ +## jQuery v3.7.1 + +### jQuery License +``` +jQuery v 3.7.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +``` diff --git a/docs/7.0.X/legal/jqueryUI.md b/docs/7.0.X/legal/jqueryUI.md new file mode 100644 index 000000000..8bda9d7a8 --- /dev/null +++ b/docs/7.0.X/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/docs/7.0.X/member-search-index.js b/docs/7.0.X/member-search-index.js new file mode 100644 index 000000000..4f531e327 --- /dev/null +++ b/docs/7.0.X/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"org.apache.datasketches.common","c":"Family","l":"A_NOT_B"},{"p":"org.apache.datasketches.common","c":"Family","l":"ALPHA"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"AnotB()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"AnotB()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"aNotB(Sketch, Sketch)","u":"aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"aNotB(Sketch, Sketch, boolean, WritableMemory)","u":"aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"aNotB(Sketch<S>, Sketch)","u":"aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"aNotB(Sketch<S>, Sketch<S>)","u":"aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.common","c":"BoundsOnBinomialProportions","l":"approximateLowerBoundOnP(long, long, double)","u":"approximateLowerBoundOnP(long,long,double)"},{"p":"org.apache.datasketches.common","c":"BoundsOnBinomialProportions","l":"approximateUpperBoundOnP(long, long, double)","u":"approximateUpperBoundOnP(long,long,double)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.PartitionBoundsRow","l":"approxNumDeltaItems"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"ArrayOfBooleansSerDe()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer.SketchType","l":"ArrayOfDoublesCompactSketch"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer.SketchType","l":"ArrayOfDoublesQuickSelectSketch"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"ArrayOfDoublesSerDe()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"ArrayOfDoublesSetOperationBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"ArrayOfDoublesSketches()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer.SketchType","l":"ArrayOfDoublesUnion"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"ArrayOfDoublesUpdatableSketchBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"ArrayOfItemsSerDe()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"ArrayOfLongsSerDe()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"ArrayOfNumbersSerDe()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"ArrayOfStringsSerDe()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSketch","l":"ArrayOfStringsSketch()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSketch","l":"ArrayOfStringsSketch(ArrayOfStringsSketch)","u":"%3Cinit%3E(org.apache.datasketches.tuple.strings.ArrayOfStringsSketch)"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSketch","l":"ArrayOfStringsSketch(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSketch","l":"ArrayOfStringsSketch(int, ResizeFactor, float)","u":"%3Cinit%3E(int,org.apache.datasketches.common.ResizeFactor,float)"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSketch","l":"ArrayOfStringsSketch(Memory)","u":"%3Cinit%3E(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummaryDeserializer","l":"ArrayOfStringsSummaryDeserializer()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummaryFactory","l":"ArrayOfStringsSummaryFactory()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummarySetOperations","l":"ArrayOfStringsSummarySetOperations()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"ArrayOfUtf16StringsSerDe()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"asDouble(long[])"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"asInt(byte[], int)","u":"asInt(byte[],int)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"asInt(double, int)","u":"asInt(double,int)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"asInt(int[], int)","u":"asInt(int[],int)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"asInt(long, int)","u":"asInt(long,int)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"asInt(long[], int)","u":"asInt(long[],int)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"asInt(String, int)","u":"asInt(java.lang.String,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"BinarySearch","l":"BinarySearch()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tdigest","c":"BinarySearch","l":"BinarySearch()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"Util","l":"bitAt(long, int)","u":"bitAt(long,int)"},{"p":"org.apache.datasketches.theta","c":"BitPacking","l":"BitPacking()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"Family","l":"BLOOMFILTER"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"BloomFilterBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchBuilder","l":"build()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnionBuilder","l":"build()"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"build()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"build()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"build()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketchBuilder","l":"build()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"build(Family)","u":"build(org.apache.datasketches.common.Family)"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"build(Family, WritableMemory)","u":"build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchBuilder","l":"build(WritableMemory)","u":"build(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnionBuilder","l":"build(WritableMemory)","u":"build(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"build(WritableMemory)","u":"build(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"build(WritableMemory)","u":"build(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"buildAnotB()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"buildANotB()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"builder()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"builder()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"builder()"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"builder()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"builder()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"buildIntersection()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"buildIntersection()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"buildIntersection(WritableMemory)","u":"buildIntersection(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"buildIntersection(WritableMemory)","u":"buildIntersection(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"buildLocal(UpdateSketch)","u":"buildLocal(org.apache.datasketches.theta.UpdateSketch)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"buildShared()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"buildShared(WritableMemory)","u":"buildShared(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"buildSharedFromSketch(UpdateSketch, WritableMemory)","u":"buildSharedFromSketch(org.apache.datasketches.theta.UpdateSketch,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"buildUnion()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"buildUnion()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"buildUnion(WritableMemory)","u":"buildUnion(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"buildUnion(WritableMemory)","u":"buildUnion(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"ByteArrayUtil()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"Util","l":"bytesToInt(byte[])"},{"p":"org.apache.datasketches.common","c":"Util","l":"bytesToLong(byte[])"},{"p":"org.apache.datasketches.common","c":"Util","l":"bytesToString(byte[], boolean, boolean, String)","u":"bytesToString(byte[],boolean,boolean,java.lang.String)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"caseIdToCornerCase(int)"},{"p":"org.apache.datasketches.common","c":"Util","l":"ceilingPowerBaseOfDouble(double, double)","u":"ceilingPowerBaseOfDouble(double,double)"},{"p":"org.apache.datasketches.common","c":"Util","l":"ceilingPowerOf2(int)"},{"p":"org.apache.datasketches.common","c":"Util","l":"ceilingPowerOf2(long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"characterPad(String, int, char, boolean)","u":"characterPad(java.lang.String,int,char,boolean)"},{"p":"org.apache.datasketches.common","c":"Util","l":"checkBounds(long, long, long)","u":"checkBounds(long,long,long)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"checkDoublesSplitPointsOrder(double[])"},{"p":"org.apache.datasketches.common","c":"Family","l":"checkFamilyID(int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"checkFloatsSplitPointsOrder(float[])"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"checkHashCorruption(long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"checkIfMultipleOf8AndGT0(long, String)","u":"checkIfMultipleOf8AndGT0(long,java.lang.String)"},{"p":"org.apache.datasketches.common","c":"Util","l":"checkIfPowerOf2(long, String)","u":"checkIfPowerOf2(long,java.lang.String)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"checkLongsSplitPointsOrder(long[])"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"checkNomLongs(int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"checkNormalizedRankBounds(double)"},{"p":"org.apache.datasketches.common","c":"Util","l":"checkProbability(double, String)","u":"checkProbability(double,java.lang.String)"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"checkSeedHashes(short, short)","u":"checkSeedHashes(short,short)"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"checkSeedHashes(short, short)","u":"checkSeedHashes(short,short)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"checkThetaCorruption(long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesCombiner","l":"combine(double[], double[])","u":"combine(double[],double[])"},{"p":"org.apache.datasketches.common","c":"Family","l":"COMPACT"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"COMPACT_EMPTY"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"COMPACT_FULL"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"COMPACT_SINGLE"},{"p":"org.apache.datasketches.quantiles","c":"UpdateDoublesSketch","l":"compact()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"compact()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"compact()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"compact()"},{"p":"org.apache.datasketches.tuple","c":"CompactSketch","l":"compact()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"compact()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"compact()"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"compact(boolean, WritableMemory)","u":"compact(boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"compact(boolean, WritableMemory)","u":"compact(boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"compact(boolean, WritableMemory)","u":"compact(boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.quantiles","c":"UpdateDoublesSketch","l":"compact(WritableMemory)","u":"compact(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"compact(WritableMemory)","u":"compact(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"compact(WritableMemory)","u":"compact(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer.SketchType","l":"CompactSketch"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"CompactSketch()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"compareTo(Group)","u":"compareTo(org.apache.datasketches.fdt.Group)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"compareTo(ItemsSketch.Row<T>)","u":"compareTo(org.apache.datasketches.frequencies.ItemsSketch.Row)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"compareTo(LongsSketch.Row)","u":"compareTo(org.apache.datasketches.frequencies.LongsSketch.Row)"},{"p":"org.apache.datasketches.cpc","c":"CompressionCharacterization","l":"CompressionCharacterization(int, int, int, int, int, int, int, PrintStream, PrintWriter)","u":"%3Cinit%3E(int,int,int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"computeBytesNeeded(int)"},{"p":"org.apache.datasketches.quantilescommon","c":"KolmogorovSmirnov","l":"computeKSDelta(QuantilesDoublesAPI, QuantilesDoublesAPI)","u":"computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesDoublesAPI,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)"},{"p":"org.apache.datasketches.quantilescommon","c":"KolmogorovSmirnov","l":"computeKSDelta(QuantilesFloatsAPI, QuantilesFloatsAPI)","u":"computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesFloatsAPI,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)"},{"p":"org.apache.datasketches.quantilescommon","c":"KolmogorovSmirnov","l":"computeKSThreshold(QuantilesAPI, QuantilesAPI, double)","u":"computeKSThreshold(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"computeSeedHash(long)"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"computeSeedHash(long)"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"ConcurrentBufferInserted"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"ConcurrentPropagated"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"continueCondition(long, long)","u":"continueCondition(long,long)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"convertToHashTable(long[], int, long, double)","u":"convertToHashTable(long[],int,long,double)"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"copy()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"copy()"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary","l":"copy()"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary","l":"copy()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSketch","l":"copy()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummary","l":"copy()"},{"p":"org.apache.datasketches.tuple","c":"Summary","l":"copy()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"copy()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"copyAs(TgtHllType)","u":"copyAs(org.apache.datasketches.hll.TgtHllType)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"copyBytes(byte[], int, byte[], int, int)","u":"copyBytes(byte[],int,byte[],int,int)"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"copySummaryArray(S[])"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"count(long[], long)","u":"count(long[],long)"},{"p":"org.apache.datasketches.common","c":"Family","l":"COUNTMIN"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"countPart(long[], int, long)","u":"countPart(long[],int,long)"},{"p":"org.apache.datasketches.common","c":"Family","l":"CPC"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"CpcSketch()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"CpcSketch(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"CpcSketch(int, long)","u":"%3Cinit%3E(int,long)"},{"p":"org.apache.datasketches.cpc","c":"CpcUnion","l":"CpcUnion()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.cpc","c":"CpcUnion","l":"CpcUnion(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.cpc","c":"CpcUnion","l":"CpcUnion(int, long)","u":"%3Cinit%3E(int,long)"},{"p":"org.apache.datasketches.cpc","c":"CpcWrapper","l":"CpcWrapper(byte[])","u":"%3Cinit%3E(byte[])"},{"p":"org.apache.datasketches.cpc","c":"CpcWrapper","l":"CpcWrapper(Memory)","u":"%3Cinit%3E(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"createByAccuracy(long, double)","u":"createByAccuracy(long,double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"createByAccuracy(long, double, long)","u":"createByAccuracy(long,double,long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"createBySize(long, int)","u":"createBySize(long,int)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"createBySize(long, int, long)","u":"createBySize(long,int,long)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases","l":"createCornerCaseId(long, int, boolean, long, int, boolean)","u":"createCornerCaseId(long,int,boolean,long,int,boolean)"},{"p":"org.apache.datasketches.tuple","c":"Sketches","l":"createEmptySketch()"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.DoublesPair","l":"cumWeights"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.FloatsPair","l":"cumWeights"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.ItemsPair","l":"cumWeights"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.LongsPair","l":"cumWeights"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"DEFAULT_HLL_TYPE"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"DEFAULT_K"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"DEFAULT_K"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"DEFAULT_LG_K"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"DEFAULT_LG_K"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"DEFAULT_NOMINAL_ENTRIES"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"DEFAULT_NOMINAL_ENTRIES"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"DEFAULT_NUMBER_OF_VALUES"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"DEFAULT_UPDATE_SEED"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Degen_Degen"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Degen_Empty"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Degen_Estimation"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Degen_Exact"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"DEGEN_MIN_0_F"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.IntersectAction","l":"DEGEN_MIN_0_F"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"DEGEN_MIN_0_F"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"DEGEN_THA_0_F"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"DEGEN_THA_0_F"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"DEGEN_THB_0_F"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"desc(double[], int, int, double, int)","u":"desc(double[],int,int,double,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"desc(float[], int, int, float, int)","u":"desc(float[],int,int,float,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"desc(long[], int, int, double, int)","u":"desc(long[],int,int,double,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"desc(long[], int, int, long, int)","u":"desc(long[],int,int,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"deserializeFromMemory(Memory, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"deserializeFromMemory(Memory, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"deserializeFromMemory(Memory, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"deserializeFromMemory(Memory, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"deserializeFromMemory(Memory, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"deserializeFromMemory(Memory, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"deserializeFromMemory(Memory, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"deserializeFromMemory(Memory, long, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"deserializeFromMemory(Memory, long, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"deserializeFromMemory(Memory, long, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"deserializeFromMemory(Memory, long, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"deserializeFromMemory(Memory, long, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"deserializeFromMemory(Memory, long, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"deserializeFromMemory(Memory, long, int)","u":"deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.tuple","c":"DeserializeResult","l":"DeserializeResult(T, int)","u":"%3Cinit%3E(T,int)"},{"p":"org.apache.datasketches.theta","c":"JaccardSimilarity","l":"dissimilarityTest(Sketch, Sketch, double)","u":"dissimilarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"dissimilarityTest(Sketch<S>, Sketch, S, SummarySetOperations<S>, double)","u":"dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"dissimilarityTest(Sketch<S>, Sketch<S>, SummarySetOperations<S>, double)","u":"dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"DOUBLES_SKETCH"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSketch","l":"DoubleSketch(int, DoubleSummary.Mode)","u":"%3Cinit%3E(int,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSketch","l":"DoubleSketch(int, int, float, DoubleSummary.Mode)","u":"%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSketch","l":"DoubleSketch(Memory, DoubleSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.DoublesPair","l":"DoublesPair(double[], long[])","u":"%3Cinit%3E(double[],long[])"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchBuilder","l":"DoublesSketchBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"DoublesSketchSortedView(double[], long[], QuantilesDoublesAPI)","u":"%3Cinit%3E(double[],long[],org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedViewIterator","l":"DoublesSortedViewIterator(double[], long[])","u":"%3Cinit%3E(double[],long[])"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary","l":"DoubleSummary(DoubleSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummaryDeserializer","l":"DoubleSummaryDeserializer()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummaryFactory","l":"DoubleSummaryFactory(DoubleSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummarySetOperations","l":"DoubleSummarySetOperations()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummarySetOperations","l":"DoubleSummarySetOperations(DoubleSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummarySetOperations","l":"DoubleSummarySetOperations(DoubleSummary.Mode, DoubleSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"DoublesUnion()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnionBuilder","l":"DoublesUnionBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"doubleToLongArray(double)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"downSample(DoublesSketch, int, WritableMemory)","u":"downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"downSample(int)"},{"p":"org.apache.datasketches.common","c":"Family","l":"EBPPS"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"EbppsItemsSketch(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitAdjSecSizeNumSec(byte)"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitAllHorizList()"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitCompactingStart(byte)"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitCompactionDetail(int, int, int, int, boolean)","u":"emitCompactionDetail(int,int,int,int,boolean)"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitCompactionDone(byte)"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitCompressDone()"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitMustAddCompactor()"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitNewCompactor(byte)"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitStart(ReqSketch)","u":"emitStart(org.apache.datasketches.req.ReqSketch)"},{"p":"org.apache.datasketches.req","c":"ReqDebug","l":"emitStartCompress()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"EMPTY_1_0_T"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.IntersectAction","l":"EMPTY_1_0_T"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"EMPTY_1_0_T"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Empty_Degen"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Empty_Empty"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Empty_Estimation"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Empty_Exact"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"EMPTY_MSG"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch.Inequality","l":"EQ"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"EQ"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"equallySpacedDoubles(int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"equallySpacedLongs(long, long, int)","u":"equallySpacedLongs(long,long,int)"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummary","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.datasketches.common","c":"BoundsOnBinomialProportions","l":"erf(double)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"estimateSubsetSum(Predicate<Long>)","u":"estimateSubsetSum(java.util.function.Predicate)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"estimateSubsetSum(Predicate<T>)","u":"estimateSubsetSum(java.util.function.Predicate)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"estimateSubsetSum(Predicate<T>)","u":"estimateSubsetSum(java.util.function.Predicate)"},{"p":"org.apache.datasketches.common","c":"BoundsOnBinomialProportions","l":"estimateUnknownP(long, long)","u":"estimateUnknownP(long,long)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Estimation_Degen"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Estimation_Empty"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Estimation_Estimation"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Estimation_Exact"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"evenlyLogSpaced(double, double, int)","u":"evenlyLogSpaced(double,double,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"evenlySpacedDoubles(double, double, int)","u":"evenlySpacedDoubles(double,double,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"evenlySpacedFloats(float, float, int)","u":"evenlySpacedFloats(float,float,int)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Exact_Degen"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Exact_Empty"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Exact_Estimation"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"Exact_Exact"},{"p":"org.apache.datasketches.common","c":"Util","l":"exactLog2OfInt(int)"},{"p":"org.apache.datasketches.common","c":"Util","l":"exactLog2OfInt(int, String)","u":"exactLog2OfInt(int,java.lang.String)"},{"p":"org.apache.datasketches.common","c":"Util","l":"exactLog2OfLong(long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"exactLog2OfLong(long, String)","u":"exactLog2OfLong(long,java.lang.String)"},{"p":"org.apache.datasketches.theta","c":"JaccardSimilarity","l":"exactlyEqual(Sketch, Sketch)","u":"exactlyEqual(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"exactlyEqual(Sketch<S>, Sketch, S, SummarySetOperations<S>)","u":"exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"exactlyEqual(Sketch<S>, Sketch<S>, SummarySetOperations<S>)","u":"exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantileSearchCriteria","l":"EXCLUSIVE"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"FdtSketch(double, double)","u":"%3Cinit%3E(double,double)"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"FdtSketch(FdtSketch)","u":"%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch)"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"FdtSketch(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.tuple","c":"Filter","l":"Filter(Predicate<T>)","u":"%3Cinit%3E(java.util.function.Predicate)"},{"p":"org.apache.datasketches.tuple","c":"Filter","l":"filter(Sketch<T>)","u":"filter(org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.quantilescommon","c":"BinarySearch","l":"find(double[], int, int, double)","u":"find(double[],int,int,double)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"find(double[], int, int, double, InequalitySearch)","u":"find(double[],int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)"},{"p":"org.apache.datasketches.quantilescommon","c":"BinarySearch","l":"find(float[], int, int, float)","u":"find(float[],int,int,float)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"find(float[], int, int, float, InequalitySearch)","u":"find(float[],int,int,float,org.apache.datasketches.quantilescommon.InequalitySearch)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"find(long[], int, int, double, InequalitySearch)","u":"find(long[],int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)"},{"p":"org.apache.datasketches.quantilescommon","c":"BinarySearch","l":"find(long[], int, int, long)","u":"find(long[],int,int,long)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"find(long[], int, int, long, InequalitySearch)","u":"find(long[],int,int,long,org.apache.datasketches.quantilescommon.InequalitySearch)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch","l":"find(T[], int, int, T, GenericInequalitySearch.Inequality, Comparator<T>)","u":"find(T[],int,int,T,org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality,java.util.Comparator)"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"FLOATS_SKETCH"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.FloatsPair","l":"FloatsPair(float[], long[])","u":"%3Cinit%3E(float[],long[])"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"FloatsSketchSortedView(float[], long[], QuantilesFloatsAPI)","u":"%3Cinit%3E(float[],long[],org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedViewIterator","l":"FloatsSortedViewIterator(float[], long[])","u":"%3Cinit%3E(float[],long[])"},{"p":"org.apache.datasketches.common","c":"Util","l":"floorPowerBaseOfDouble(double, double)","u":"floorPowerBaseOfDouble(double,double)"},{"p":"org.apache.datasketches.common","c":"Util","l":"floorPowerOf2(int)"},{"p":"org.apache.datasketches.common","c":"Util","l":"floorPowerOf2(long)"},{"p":"org.apache.datasketches.common","c":"Family","l":"FREQUENCY"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary","l":"fromMemory(Memory)","u":"fromMemory(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary","l":"fromMemory(Memory)","u":"fromMemory(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.hll","c":"TgtHllType","l":"fromOrdinal(int)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"FULL_ANOTB"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.IntersectAction","l":"FULL_INTERSECT"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"FULL_UNION"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch.Inequality","l":"GE"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"GE"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch","l":"GenericInequalitySearch()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"GenericPartitionBoundaries(long, T[], long[], double[], T, T, QuantileSearchCriteria)","u":"%3Cinit%3E(long,T[],long[],double[],T,T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedViewIterator","l":"GenericSortedViewIterator(T[], long[])","u":"%3Cinit%3E(T[],long[])"},{"p":"org.apache.datasketches.theta","c":"HashIterator","l":"get()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"getActionDescription()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.IntersectAction","l":"getActionDescription()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"getActionDescription()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"getActionId()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.IntersectAction","l":"getActionId()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"getActionId()"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"getActiveEntries()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"getAnotbAction()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getAprioriError(int, long)","u":"getAprioriError(int,long)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getAprioriError(int, long)","u":"getAprioriError(int,long)"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"getAverageSketchMemoryPerKey()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"getBitsUsed()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getBoundaries()"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"getBytes()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"getC()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"getCapacity()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"getCaseDescription()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getCDF(double[])"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getCDF(double[])"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getCDF(double[], QuantileSearchCriteria)","u":"getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getCDF(double[], QuantileSearchCriteria)","u":"getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"getCDF(double[], QuantileSearchCriteria)","u":"getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getCDF(double[], QuantileSearchCriteria)","u":"getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getCDF(float[])"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getCDF(float[], QuantileSearchCriteria)","u":"getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"getCDF(float[], QuantileSearchCriteria)","u":"getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getCDF(float[], QuantileSearchCriteria)","u":"getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getCDF(float[], QuantileSearchCriteria)","u":"getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getCDF(long[])"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getCDF(long[], QuantileSearchCriteria)","u":"getCDF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"getCDF(long[], QuantileSearchCriteria)","u":"getCDF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getCDF(long[], QuantileSearchCriteria)","u":"getCDF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getCDF(T[])"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getCDF(T[], QuantileSearchCriteria)","u":"getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getCDF(T[], QuantileSearchCriteria)","u":"getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getCDF(T[], QuantileSearchCriteria)","u":"getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getCDF(T[], QuantileSearchCriteria)","u":"getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"getClassOfT()"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"getClassOfT()"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"getClassOfT()"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"getClassOfT()"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"getClassOfT()"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"getClassOfT()"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"getClassOfT()"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getClassOfT()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getClassOfT()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getClassOfT()"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"getCompactBytes()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getCompactBytes()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"getCompactBytes()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getCompactSerialiedSizeBytes(int, long)","u":"getCompactSerialiedSizeBytes(int,long)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getCompactSerializationBytes()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getCompactSerializationBytes()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getCompactSketchMaxBytes(int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getCompactSketchMaxBytes(int)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getComparator()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getComparator()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getComparator()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getComparator()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getComparator()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getCompositeEstimate()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getCompositeEstimate()"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getCount()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getCountLessThanThetaLong(long)"},{"p":"org.apache.datasketches.tuple","c":"CompactSketch","l":"getCountLessThanThetaLong(long)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"getCountLessThanThetaLong(long)"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getCountLessThanThetaLong(long)"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"getCumulativeWeight()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getCumulativeWeights()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getCumulativeWeights()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getCumulativeWeights()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getCumulativeWeights()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedView","l":"getCumulativeWeights()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getCurrentBytes()"},{"p":"org.apache.datasketches.theta","c":"Union","l":"getCurrentBytes()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesCompactSketch","l":"getCurrentBytes()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getCurrentBytes()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"getCurrentCapacity()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getCurrentCompactSerializedSizeBytes()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getCurrentMapCapacity()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getCurrentMapCapacity()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getCurrentUpdatableSerializedSizeBytes()"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getDoubleBE(byte[], int)","u":"getDoubleBE(byte[],int)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getDoubleLE(byte[], int)","u":"getDoubleLE(byte[],int)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"getEffectiveK()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getEffectiveK()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getEpsilon(int)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getEpsilon(int)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"getEstimate()"},{"p":"org.apache.datasketches.cpc","c":"CpcWrapper","l":"getEstimate()"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getEstimate()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"getEstimate()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"getEstimate()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getEstimate()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getEstimate()"},{"p":"org.apache.datasketches.sampling","c":"SampleSubsetSummary","l":"getEstimate()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getEstimate()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getEstimate()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getEstimate()"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"getEstimate(byte[])"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getEstimate(int)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getEstimate(long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getEstimate(Memory)","u":"getEstimate(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getEstimate(T)"},{"p":"org.apache.datasketches.common","c":"BoundsOnRatiosInSampledSets","l":"getEstimateOfA(long, double)","u":"getEstimateOfA(long,double)"},{"p":"org.apache.datasketches.common","c":"BoundsOnRatiosInSampledSets","l":"getEstimateOfB(long, double)","u":"getEstimateOfB(long,double)"},{"p":"org.apache.datasketches.common","c":"BoundsOnRatiosInSampledSets","l":"getEstimateOfBoverA(long, long)","u":"getEstimateOfBoverA(long,long)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInThetaSketchedSets","l":"getEstimateOfBoverA(Sketch, Sketch)","u":"getEstimateOfBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInTupleSketchedSets","l":"getEstimateOfBoverA(Sketch<S>, Sketch)","u":"getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInTupleSketchedSets","l":"getEstimateOfBoverA(Sketch<S>, Sketch<S>)","u":"getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"getFamily()"},{"p":"org.apache.datasketches.cpc","c":"CpcUnion","l":"getFamily()"},{"p":"org.apache.datasketches.cpc","c":"CpcWrapper","l":"getFamily()"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"getFamily()"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"getFamily()"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"getFamily()"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"getFamily()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getFamily()"},{"p":"org.apache.datasketches.theta","c":"Union","l":"getFamily()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getFamily()"},{"p":"org.apache.datasketches.common","c":"Family","l":"getFamilyName()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"getFillPercentage()"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getFloatBE(byte[], int)","u":"getFloatBE(byte[],int)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getFloatLE(byte[], int)","u":"getFloatLE(byte[],int)"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getFraction()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getFrequentItems(ErrorType)","u":"getFrequentItems(org.apache.datasketches.frequencies.ErrorType)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getFrequentItems(ErrorType)","u":"getFrequentItems(org.apache.datasketches.frequencies.ErrorType)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getFrequentItems(long, ErrorType)","u":"getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getFrequentItems(long, ErrorType)","u":"getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)"},{"p":"org.apache.datasketches.fdt","c":"PostProcessor","l":"getGroupCount()"},{"p":"org.apache.datasketches.fdt","c":"PostProcessor","l":"getGroupList(int[], int, int)","u":"getGroupList(int[],int,int)"},{"p":"org.apache.datasketches.tuple","c":"TupleSketchIterator","l":"getHash()"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getHeader()"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"getHighRankAccuracy()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getHighRankAccuracyMode()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"getId()"},{"p":"org.apache.datasketches.common","c":"Family","l":"getID()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getInstance(Class<T>, Comparator<? super T>)","u":"getInstance(java.lang.Class,java.util.Comparator)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getInstance(Class<T>, Comparator<? super T>)","u":"getInstance(java.lang.Class,java.util.Comparator)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getInstance(Class<T>, int, Comparator<? super T>)","u":"getInstance(java.lang.Class,int,java.util.Comparator)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getInstance(Class<T>, int, Comparator<? super T>)","u":"getInstance(java.lang.Class,int,java.util.Comparator)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getInstance(Class<T>, Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)","u":"getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getInstance(Class<T>, Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)","u":"getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getInstance(ItemsSketch<T>)","u":"getInstance(org.apache.datasketches.quantiles.ItemsSketch)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getInstance(Memory)","u":"getInstance(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getInstance(Memory, ArrayOfItemsSerDe<T>)","u":"getInstance(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getInstance(String)","u":"getInstance(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getIntBE(byte[], int)","u":"getIntBE(byte[],int)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"getIntersectAction()"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getIntLE(byte[], int)","u":"getIntLE(byte[],int)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"getItem()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"getItem()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples.WeightedSample","l":"getItem()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getK()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchBuilder","l":"getK()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getK()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"getK()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getK()"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"getK()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"getK()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"getK()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"getK()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"getK()"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getK()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketchIterator","l":"getKey()"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"getKeyMemoryUsageBytes()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"getKFromEpsilon(double, boolean)","u":"getKFromEpsilon(double,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ClassicUtil","l":"getKFromEpsilon(double, boolean)","u":"getKFromEpsilon(double,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getKFromEpsilon(double, boolean)","u":"getKFromEpsilon(double,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getKFromEpsilon(double, boolean)","u":"getKFromEpsilon(double,boolean)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getLgConfigK()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getLgConfigK()"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"getLgK()"},{"p":"org.apache.datasketches.cpc","c":"CpcUnion","l":"getLgK()"},{"p":"org.apache.datasketches.cpc","c":"CpcWrapper","l":"getLgK()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"getLgK()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"getLgNominalEntries()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getLgNominalEntries()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"getLgNomLongs()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getLocalLgNominalEntries()"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getLongBE(byte[], int)","u":"getLongBE(byte[],int)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getLongLE(byte[], int)","u":"getLongLE(byte[],int)"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getLowerBound()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"getLowerBound()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"getLowerBound()"},{"p":"org.apache.datasketches.sampling","c":"SampleSubsetSummary","l":"getLowerBound()"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"getLowerBound(byte[])"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"getLowerBound(int)"},{"p":"org.apache.datasketches.cpc","c":"CpcWrapper","l":"getLowerBound(int)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getLowerBound(int)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getLowerBound(int)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getLowerBound(int)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getLowerBound(int)"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getLowerBound(int)"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getLowerBound(int, int)","u":"getLowerBound(int,int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getLowerBound(int, Memory)","u":"getLowerBound(int,org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getLowerBound(long)"},{"p":"org.apache.datasketches.thetacommon","c":"BinomialBoundsN","l":"getLowerBound(long, double, int, boolean)","u":"getLowerBound(long,double,int,boolean)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getLowerBound(T)"},{"p":"org.apache.datasketches.common","c":"BoundsOnRatiosInSampledSets","l":"getLowerBoundForBoverA(long, long, double)","u":"getLowerBoundForBoverA(long,long,double)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInThetaSketchedSets","l":"getLowerBoundForBoverA(Sketch, Sketch)","u":"getLowerBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInTupleSketchedSets","l":"getLowerBoundForBoverA(Sketch<S>, Sketch)","u":"getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInTupleSketchedSets","l":"getLowerBoundForBoverA(Sketch<S>, Sketch<S>)","u":"getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"getMaxAnotBResultBytes(int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getMaxAnotBResultBytes(int)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesCompactSketch","l":"getMaxBytes()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getMaxBytes()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"getMaxBytes(int, int)","u":"getMaxBytes(int,int)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getMaxCompactSketchBytes(int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getMaxCompactSketchBytes(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getMaxConcurrencyError()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getMaximumError()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getMaximumError()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getMaximumMapCapacity()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getMaximumMapCapacity()"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"getMaxIntersectionBytes(int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getMaxIntersectionBytes(int)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getMaxItem()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getMaxItem()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"getMaxK()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnionBuilder","l":"getMaxK()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getMaxK()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"getMaxK()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"getMaxK()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getMaxNumLocalThreads()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getMaxPartitions()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getMaxPartitions()"},{"p":"org.apache.datasketches.quantilescommon","c":"SketchPartitionLimits","l":"getMaxPartitions()"},{"p":"org.apache.datasketches.common","c":"Family","l":"getMaxPreLongs()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getMaxSerializationBytes(int)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"getMaxSerializedBytes(int)"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"getMaxSerializedSizeBytes(int, long, KllSketch.SketchType, boolean)","u":"getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"getMaxUnionBytes()"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"getMaxUnionBytes(int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getMaxUnionBytes(int)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getMaxUpdatableSerializationBytes(int, TgtHllType)","u":"getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getMaxUpdateSketchBytes(int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getMaxUpdateSketchBytes(int)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getMaxValue()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"getMemoryRequestServer()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getMemoryRequestServer()"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"getMemoryUsageBytes()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getMinItem()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getMinItem()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getMinItem()"},{"p":"org.apache.datasketches.quantilescommon","c":"SketchPartitionLimits","l":"getMinPartitionSizeItems()"},{"p":"org.apache.datasketches.common","c":"Family","l":"getMinPreLongs()"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getMinValue()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getN()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"SketchPartitionLimits","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedView","l":"getN()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedViewIterator","l":"getN()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getN()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"getN()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"getN()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"getN()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"getN()"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"getName()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedViewIterator","l":"getNaturalRank()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"getNaturalRank(double, long, QuantileSearchCriteria)","u":"getNaturalRank(double,long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedViewIterator","l":"getNaturalRank(QuantileSearchCriteria)","u":"getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getNaturalRanks()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"getNominalEntries()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"getNominalEntries()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedViewIterator","l":"getNormalizedRank()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedViewIterator","l":"getNormalizedRank(QuantileSearchCriteria)","u":"getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"getNormalizedRankError(boolean)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getNormalizedRankError(boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getNormalizedRankError(boolean)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"getNormalizedRankError(boolean)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getNormalizedRankError(boolean)"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"getNormalizedRankError(int, boolean)","u":"getNormalizedRankError(int,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ClassicUtil","l":"getNormalizedRankError(int, boolean)","u":"getNormalizedRankError(int,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getNormalizedRankError(int, boolean)","u":"getNormalizedRankError(int,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getNormalizedRankError(int, boolean)","u":"getNormalizedRankError(int,boolean)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getNormalizedRanks()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getNumActiveItems()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getNumActiveItems()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getNumDeltaItems()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"getNumHashes()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getNumPartitions()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getNumPoolThreads()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"getNumRetained()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedView","l":"getNumRetained()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getNumRetained()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"getNumSamples()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"getNumSamples()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples","l":"getNumSamples()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"getNumSamples()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getNumValues()"},{"p":"org.apache.datasketches.tuple","c":"DeserializeResult","l":"getObject()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"getP()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getP()"},{"p":"org.apache.datasketches.quantilescommon","c":"PartitioningFeature","l":"getPartitionBoundariesFromNumParts(int)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)","u":"getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)","u":"getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)","u":"getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"PartitioningFeature","l":"getPartitionBoundariesFromNumParts(int, QuantileSearchCriteria)","u":"getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"PartitioningFeature","l":"getPartitionBoundariesFromPartSize(long)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)","u":"getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)","u":"getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)","u":"getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"PartitioningFeature","l":"getPartitionBoundariesFromPartSize(long, QuantileSearchCriteria)","u":"getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getPMF(double[])"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getPMF(double[])"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getPMF(double[], QuantileSearchCriteria)","u":"getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getPMF(double[], QuantileSearchCriteria)","u":"getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"getPMF(double[], QuantileSearchCriteria)","u":"getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getPMF(double[], QuantileSearchCriteria)","u":"getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getPMF(float[])"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getPMF(float[], QuantileSearchCriteria)","u":"getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"getPMF(float[], QuantileSearchCriteria)","u":"getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getPMF(float[], QuantileSearchCriteria)","u":"getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getPMF(float[], QuantileSearchCriteria)","u":"getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getPMF(long[])"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getPMF(long[], QuantileSearchCriteria)","u":"getPMF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"getPMF(long[], QuantileSearchCriteria)","u":"getPMF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getPMF(long[], QuantileSearchCriteria)","u":"getPMF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getPMF(T[])"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getPMF(T[], QuantileSearchCriteria)","u":"getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getPMF(T[], QuantileSearchCriteria)","u":"getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getPMF(T[], QuantileSearchCriteria)","u":"getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getPMF(T[], QuantileSearchCriteria)","u":"getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"getPostProcessor()"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"getPostProcessor(Group, char)","u":"getPostProcessor(org.apache.datasketches.fdt.Group,char)"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"getPreInts()"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getPrimaryKey()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getPropagateOrderedCompact()"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedViewIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedViewIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedViewIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedViewIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.req","c":"ReqSketchIterator","l":"getQuantile()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getQuantile(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getQuantile(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getQuantile(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getQuantile(double)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getQuantile(double)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getQuantile(double, QuantileSearchCriteria)","u":"getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedViewIterator","l":"getQuantile(QuantileSearchCriteria)","u":"getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getQuantileLowerBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getQuantileLowerBound(double, int)","u":"getQuantileLowerBound(double,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"getQuantiles()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getQuantiles(double[])"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getQuantiles(double[])"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getQuantiles(double[])"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getQuantiles(double[])"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getQuantiles(double[], QuantileSearchCriteria)","u":"getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getQuantileUpperBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getQuantileUpperBound(double, int)","u":"getQuantileUpperBound(double,int)"},{"p":"org.apache.datasketches.partitions","c":"SketchFillRequest","l":"getRange(T, T, BoundsRule)","u":"getRange(T,T,org.apache.datasketches.partitions.BoundsRule)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getRank(double)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getRank(double)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getRank(double, QuantileSearchCriteria)","u":"getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getRank(double, QuantileSearchCriteria)","u":"getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"getRank(double, QuantileSearchCriteria)","u":"getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"getRank(double, QuantileSearchCriteria)","u":"getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getRank(double, QuantileSearchCriteria)","u":"getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getRank(float)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getRank(float, QuantileSearchCriteria)","u":"getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"getRank(float, QuantileSearchCriteria)","u":"getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"getRank(float, QuantileSearchCriteria)","u":"getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getRank(float, QuantileSearchCriteria)","u":"getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getRank(float, QuantileSearchCriteria)","u":"getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getRank(long)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getRank(long, QuantileSearchCriteria)","u":"getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"getRank(long, QuantileSearchCriteria)","u":"getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"getRank(long, QuantileSearchCriteria)","u":"getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getRank(long, QuantileSearchCriteria)","u":"getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getRank(T)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getRank(T, QuantileSearchCriteria)","u":"getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getRank(T, QuantileSearchCriteria)","u":"getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"getRank(T, QuantileSearchCriteria)","u":"getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"getRank(T, QuantileSearchCriteria)","u":"getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getRank(T, QuantileSearchCriteria)","u":"getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getRankLowerBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getRankLowerBound(double, int)","u":"getRankLowerBound(double,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getRanks(double[])"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getRanks(double[], QuantileSearchCriteria)","u":"getRanks(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getRanks(double[], QuantileSearchCriteria)","u":"getRanks(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getRanks(double[], QuantileSearchCriteria)","u":"getRanks(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getRanks(float[])"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getRanks(float[], QuantileSearchCriteria)","u":"getRanks(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getRanks(float[], QuantileSearchCriteria)","u":"getRanks(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getRanks(float[], QuantileSearchCriteria)","u":"getRanks(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getRanks(long[])"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getRanks(long[], QuantileSearchCriteria)","u":"getRanks(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getRanks(long[], QuantileSearchCriteria)","u":"getRanks(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getRanks(T[])"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getRanks(T[], QuantileSearchCriteria)","u":"getRanks(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getRanks(T[], QuantileSearchCriteria)","u":"getRanks(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getRanks(T[], QuantileSearchCriteria)","u":"getRanks(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getRankUpperBound(double)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getRankUpperBound(double, int)","u":"getRankUpperBound(double,int)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getRelErr(boolean, boolean, int, int)","u":"getRelErr(boolean,boolean,int,int)"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"getReqDebug()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"getResizeFactor()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"getResizeFactor()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getResizeFactor()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"getResizeFactor()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"getResizeFactor()"},{"p":"org.apache.datasketches.cpc","c":"CpcUnion","l":"getResult()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getResult()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"getResult()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getResult()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"getResult()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"getResult()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"getResult()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"getResult()"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"getResult()"},{"p":"org.apache.datasketches.theta","c":"Union","l":"getResult()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesAnotB","l":"getResult()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesAnotBImpl","l":"getResult()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesIntersection","l":"getResult()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"getResult()"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"getResult()"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"getResult()"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"getResult(boolean)"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"getResult(boolean)"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"getResult(boolean)"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"getResult(boolean, WritableMemory)","u":"getResult(boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"getResult(boolean, WritableMemory)","u":"getResult(boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"getResult(boolean, WritableMemory, boolean)","u":"getResult(boolean,org.apache.datasketches.memory.WritableMemory,boolean)"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"getResult(int[], int, int, char)","u":"getResult(int[],int,int,char)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getResult(TgtHllType)","u":"getResult(org.apache.datasketches.hll.TgtHllType)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"getResult(WritableMemory)","u":"getResult(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesAnotB","l":"getResult(WritableMemory)","u":"getResult(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesAnotBImpl","l":"getResult(WritableMemory)","u":"getResult(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesIntersection","l":"getResult(WritableMemory)","u":"getResult(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"getResult(WritableMemory)","u":"getResult(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"getResultAndReset()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"getResultAndReset()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getRetainedEntries()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getRetainedEntries()"},{"p":"org.apache.datasketches.tuple","c":"CompactSketch","l":"getRetainedEntries()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"getRetainedEntries()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getRetainedEntries()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getRetainedEntries(boolean)"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"getRF(int)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"getRowHeader()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"getRowHeader()"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getRse()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getRSE(int, double, boolean, long)","u":"getRSE(int,double,boolean,long)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"getSamples()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"getSamples()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"getSamples(Class<?>)","u":"getSamples(java.lang.Class)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"getSamplingProbability()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"getSamplingProbability()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericPartitionBoundaries","l":"getSearchCriteria()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"getSeed()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"getSeed()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"getSeed()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getSerializationVersion()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getSerializationVersion(Memory)","u":"getSerializationVersion(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getSerializationVersion(Memory)","u":"getSerializationVersion(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getSerializationVersion(Memory)","u":"getSerializationVersion(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"getSerializedFilterSize(long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"getSerializedFilterSizeByAccuracy(long, double)","u":"getSerializedFilterSizeByAccuracy(long,double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"getSerializedSize(long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"getSerializedSizeBytes()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"getSerializedSizeBytes()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getSerializedSizeBytes()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getSerializedSizeBytes()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getSerializedSizeBytes()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getSerializedSizeBytes()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getSerializedSizeBytes()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"getSerializedSizeBytes(ArrayOfItemsSerDe<? super T>)","u":"getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"getSerializedSizeBytes(ArrayOfItemsSerDe<? super T>, Class<?>)","u":"getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"getSerVer()"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getShortBE(byte[], int)","u":"getShortBE(byte[],int)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"getShortLE(byte[], int)","u":"getShortLE(byte[],int)"},{"p":"org.apache.datasketches.tuple","c":"DeserializeResult","l":"getSize()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"getSketchSamples()"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"getSketchStructure(int, int)","u":"getSketchStructure(int,int)"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer","l":"getSketchType(Memory)","u":"getSketchType(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"getSortedView()"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"getSortedView()"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"getSortedView()"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"getSortedView()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getSortedView()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"getSortedView()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"getSortedView()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"getSortedView()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"getSortedView()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"getSortedView()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"getSortedView()"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"getStartingCapacity(int, int)","u":"getStartingCapacity(int,int)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getStorageBytes()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getStreamLength()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getStreamLength()"},{"p":"org.apache.datasketches.tuple","c":"TupleSketchIterator","l":"getSummary()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getSummaryFactory()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getTgtHllType()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getTgtHllType()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getTheta()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getTheta()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getTheta()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getThetaLong()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getThetaLong()"},{"p":"org.apache.datasketches.sampling","c":"SampleSubsetSummary","l":"getTotalSketchWeight()"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"getTotalWeight()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"getUnionAction()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getUpdatableSerializationBytes()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getUpdatableSerializationBytes()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"getUpdatableStorageBytes(int, long)","u":"getUpdatableStorageBytes(int,long)"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"getUpperBound()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"getUpperBound()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"getUpperBound()"},{"p":"org.apache.datasketches.sampling","c":"SampleSubsetSummary","l":"getUpperBound()"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"getUpperBound(byte[])"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"getUpperBound(int)"},{"p":"org.apache.datasketches.cpc","c":"CpcWrapper","l":"getUpperBound(int)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"getUpperBound(int)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"getUpperBound(int)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"getUpperBound(int)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getUpperBound(int)"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getUpperBound(int)"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"getUpperBound(int, int)","u":"getUpperBound(int,int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"getUpperBound(int, Memory)","u":"getUpperBound(int,org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"getUpperBound(long)"},{"p":"org.apache.datasketches.thetacommon","c":"BinomialBoundsN","l":"getUpperBound(long, double, int, boolean)","u":"getUpperBound(long,double,int,boolean)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"getUpperBound(T)"},{"p":"org.apache.datasketches.common","c":"BoundsOnRatiosInSampledSets","l":"getUpperBoundForBoverA(long, long, double)","u":"getUpperBoundForBoverA(long,long,double)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInThetaSketchedSets","l":"getUpperBoundForBoverA(Sketch, Sketch)","u":"getUpperBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInTupleSketchedSets","l":"getUpperBoundForBoverA(Sketch<S>, Sketch)","u":"getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.thetacommon","c":"BoundsOnRatiosInTupleSketchedSets","l":"getUpperBoundForBoverA(Sketch<S>, Sketch<S>)","u":"getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"getValue()"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary","l":"getValue()"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary","l":"getValue()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummary","l":"getValue()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"getValues()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketchIterator","l":"getValues()"},{"p":"org.apache.datasketches.kll","c":"KllSketchIterator","l":"getWeight()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchIterator","l":"getWeight()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketchIterator","l":"getWeight()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesSketchIterator","l":"getWeight()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedViewIterator","l":"getWeight()"},{"p":"org.apache.datasketches.req","c":"ReqSketchIterator","l":"getWeight()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples.WeightedSample","l":"getWeight()"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.StackElement","l":"gpb"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"Group()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch.Inequality","l":"GT"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"GT"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(byte[], int, int, long)","u":"hash(byte[],int,int,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(byte[], long)","u":"hash(byte[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(ByteBuffer, long)","u":"hash(java.nio.ByteBuffer,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(char[], int, int, long)","u":"hash(char[],int,int,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(char[], long)","u":"hash(char[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(int[], int, int, long)","u":"hash(int[],int,int,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(int[], long)","u":"hash(int[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(long, long)","u":"hash(long,long)"},{"p":"org.apache.datasketches.hash","c":"XxHash","l":"hash(long, long)","u":"hash(long,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(long[], int, int, long)","u":"hash(long[],int,int,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(long[], long)","u":"hash(long[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3","l":"hash(Memory, long)","u":"hash(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.hash","c":"XxHash","l":"hash(Memory, long, long, long)","u":"hash(org.apache.datasketches.memory.Memory,long,long,long)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"hashArrayInsert(long[], long[], int, long)","u":"hashArrayInsert(long[],long[],int,long)"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"hashCode()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"hashCode()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"hashCode()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummary","l":"hashCode()"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"hashInsertOnly(long[], int, long)","u":"hashInsertOnly(long[],int,long)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"hashInsertOnlyMemory(WritableMemory, int, long, int)","u":"hashInsertOnlyMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"hashSearch(long[], int, long)","u":"hashSearch(long[],int,long)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"hashSearchMemory(Memory, int, long, int)","u":"hashSearchMemory(org.apache.datasketches.memory.Memory,int,long,int)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"hashSearchOrInsert(long[], int, long)","u":"hashSearchOrInsert(long[],int,long)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"hashSearchOrInsertMemory(WritableMemory, int, long, int)","u":"hashSearchOrInsertMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToBytes(byte[], long)","u":"hashToBytes(byte[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToBytes(char[], long)","u":"hashToBytes(char[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToBytes(double, long)","u":"hashToBytes(double,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToBytes(int[], long)","u":"hashToBytes(int[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToBytes(long, long)","u":"hashToBytes(long,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToBytes(long[], long)","u":"hashToBytes(long[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToBytes(String, long)","u":"hashToBytes(java.lang.String,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToLongs(byte[], long)","u":"hashToLongs(byte[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToLongs(char[], long)","u":"hashToLongs(char[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToLongs(double, long)","u":"hashToLongs(double,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToLongs(int[], long)","u":"hashToLongs(int[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToLongs(long, long)","u":"hashToLongs(long,long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToLongs(long[], long)","u":"hashToLongs(long[],long)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"hashToLongs(String, long)","u":"hashToLongs(java.lang.String,long)"},{"p":"org.apache.datasketches.common","c":"MemoryStatus","l":"hasMemory()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"hasMemory()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"DirectBitArrayR","l":"hasMemory()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"hasMemory()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"hasMemory()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"hasMemory()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"hasMemory()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"hasMemory()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"hasMemory()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"hasMemory()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples.VarOptItemsIterator","l":"hasNext()"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"hasResult()"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"hasResult()"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"heapify(byte[])"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"heapify(byte[])"},{"p":"org.apache.datasketches.hll","c":"Union","l":"heapify(byte[])"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"heapify(byte[], long)","u":"heapify(byte[],long)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"heapify(DoublesSketch)","u":"heapify(org.apache.datasketches.quantiles.DoublesSketch)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"UpdateDoublesSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"heapify(Memory)","u":"heapify(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"heapify(Memory, ArrayOfItemsSerDe<T>)","u":"heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"heapify(Memory, ArrayOfItemsSerDe<T>)","u":"heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"heapify(Memory, ArrayOfItemsSerDe<T>)","u":"heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"heapify(Memory, ArrayOfItemsSerDe<T>)","u":"heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"heapify(Memory, ArrayOfItemsSerDe<T>)","u":"heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"heapify(Memory, boolean)","u":"heapify(org.apache.datasketches.memory.Memory,boolean)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"heapify(Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)","u":"heapify(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"heapify(Memory, long)","u":"heapify(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifyCompactSketch(Memory)","u":"heapifyCompactSketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifyCompactSketch(Memory, long)","u":"heapifyCompactSketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifySetOperation(Memory)","u":"heapifySetOperation(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifySetOperation(Memory, long)","u":"heapifySetOperation(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifySketch(Memory)","u":"heapifySketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"heapifySketch(Memory)","u":"heapifySketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifySketch(Memory, long)","u":"heapifySketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"heapifySketch(Memory, long)","u":"heapifySketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple","c":"Sketches","l":"heapifySketch(Memory, SummaryDeserializer<S>)","u":"heapifySketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummaryDeserializer","l":"heapifySummary(Memory)","u":"heapifySummary(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummaryDeserializer","l":"heapifySummary(Memory)","u":"heapifySummary(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummaryDeserializer","l":"heapifySummary(Memory)","u":"heapifySummary(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple","c":"SummaryDeserializer","l":"heapifySummary(Memory)","u":"heapifySummary(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"heapifyUnion(Memory)","u":"heapifyUnion(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"heapifyUnion(Memory, long)","u":"heapifyUnion(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"heapifyUpdatableSketch(Memory)","u":"heapifyUpdatableSketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"heapifyUpdatableSketch(Memory, long)","u":"heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple","c":"Sketches","l":"heapifyUpdatableSketch(Memory, SummaryDeserializer<S>, SummaryFactory<S>)","u":"heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifyUpdateSketch(Memory)","u":"heapifyUpdateSketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"heapifyUpdateSketch(Memory, long)","u":"heapifyUpdateSketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.common","c":"Family","l":"HLL"},{"p":"org.apache.datasketches.hll","c":"TgtHllType","l":"HLL_4"},{"p":"org.apache.datasketches.hll","c":"TgtHllType","l":"HLL_6"},{"p":"org.apache.datasketches.hll","c":"TgtHllType","l":"HLL_8"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"HllSketch()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"HllSketch(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"HllSketch(int, TgtHllType)","u":"%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"HllSketch(int, TgtHllType, WritableMemory)","u":"%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.common","c":"Family","l":"idToFamily(int)"},{"p":"org.apache.datasketches.partitions","c":"BoundsRule","l":"INCLUDE_BOTH"},{"p":"org.apache.datasketches.partitions","c":"BoundsRule","l":"INCLUDE_LOWER"},{"p":"org.apache.datasketches.partitions","c":"BoundsRule","l":"INCLUDE_NEITHER"},{"p":"org.apache.datasketches.partitions","c":"BoundsRule","l":"INCLUDE_UPPER"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax","l":"includeDoublesMinMax(double[], long[], double, double)","u":"includeDoublesMinMax(double[],long[],double,double)"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax","l":"includeFloatsMinMax(float[], long[], float, float)","u":"includeFloatsMinMax(float[],long[],float,float)"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax","l":"includeItemsMinMax(T[], long[], T, T, Comparator<? super T>)","u":"includeItemsMinMax(T[],long[],T,T,java.util.Comparator)"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax","l":"includeLongsMinMax(long[], long[], long, long)","u":"includeLongsMinMax(long[],long[],long,long)"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax","l":"IncludeMinMax()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantileSearchCriteria","l":"INCLUSIVE"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"init(String, int, double, double, double, double, double)","u":"init(java.lang.String,int,double,double,double,double,double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"initializeByAccuracy(long, double, long, WritableMemory)","u":"initializeByAccuracy(long,double,long,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"initializeByAccuracy(long, double, WritableMemory)","u":"initializeByAccuracy(long,double,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"initializeBySize(long, int, long, WritableMemory)","u":"initializeBySize(long,int,long,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"initializeBySize(long, int, WritableMemory)","u":"initializeBySize(long,int,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"InsertedCountIncremented"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"InsertedCountIncrementedRebuilt"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"InsertedCountIncrementedResized"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"InsertedCountNotIncremented"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSketch","l":"IntegerSketch(int, int, float, IntegerSummary.Mode)","u":"%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSketch","l":"IntegerSketch(int, IntegerSummary.Mode)","u":"%3Cinit%3E(int,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSketch","l":"IntegerSketch(Memory, IntegerSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary","l":"IntegerSummary(IntegerSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummaryDeserializer","l":"IntegerSummaryDeserializer()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummaryFactory","l":"IntegerSummaryFactory(IntegerSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummarySetOperations","l":"IntegerSummarySetOperations(IntegerSummary.Mode, IntegerSummary.Mode)","u":"%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesIntersection","l":"intersect(ArrayOfDoublesSketch, ArrayOfDoublesCombiner)","u":"intersect(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"intersect(BloomFilter)","u":"intersect(org.apache.datasketches.filters.bloomfilter.BloomFilter)"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"intersect(Sketch)","u":"intersect(org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"intersect(Sketch, S)","u":"intersect(org.apache.datasketches.theta.Sketch,S)"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"intersect(Sketch, Sketch)","u":"intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"intersect(Sketch, Sketch, boolean, WritableMemory)","u":"intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"intersect(Sketch<S>)","u":"intersect(org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"intersect(Sketch<S>, Sketch, S)","u":"intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"intersect(Sketch<S>, Sketch<S>)","u":"intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.common","c":"Family","l":"INTERSECTION"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"Intersection()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummarySetOperations","l":"intersection(ArrayOfStringsSummary, ArrayOfStringsSummary)","u":"intersection(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummarySetOperations","l":"intersection(DoubleSummary, DoubleSummary)","u":"intersection(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummarySetOperations","l":"intersection(IntegerSummary, IntegerSummary)","u":"intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)"},{"p":"org.apache.datasketches.tuple","c":"SummarySetOperations","l":"intersection(S, S)","u":"intersection(S,S)"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"Intersection(SummarySetOperations<S>)","u":"%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)"},{"p":"org.apache.datasketches.common","c":"Util","l":"intToBytes(int, byte[])","u":"intToBytes(int,byte[])"},{"p":"org.apache.datasketches.common","c":"Util","l":"INVERSE_GOLDEN"},{"p":"org.apache.datasketches.common","c":"Util","l":"INVERSE_GOLDEN_U64"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"invert()"},{"p":"org.apache.datasketches.common","c":"Util","l":"invPow2(int)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"isCompact()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"isCompact()"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"isCompact()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"isCompact()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"isCompact()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"isCompactMemoryFormat()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"isCompatible(BloomFilter)","u":"isCompatible(org.apache.datasketches.filters.bloomfilter.BloomFilter)"},{"p":"org.apache.datasketches.common","c":"MemoryStatus","l":"isDirect()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"isDirect()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"DirectBitArrayR","l":"isDirect()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"isDirect()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"isDirect()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"isDirect()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"isDirect()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"isDirect()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"isDirect()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"isDirect()"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"isEmpty()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"isEmpty()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"isEmpty()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"isEmpty()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"isEmpty()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"isEmpty()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"isEmpty()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"isEmpty()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"isEmpty()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedView","l":"isEmpty()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"isEmpty()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"isEmpty()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"isEmpty()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"isEmpty()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"isEstimationMode()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"isEstimationMode()"},{"p":"org.apache.datasketches.common","c":"Util","l":"isEven(long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"isLessThanUnsigned(long, long)","u":"isLessThanUnsigned(long,long)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"isMemory()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"isMemory()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"isMemoryUpdatableFormat()"},{"p":"org.apache.datasketches.common","c":"Util","l":"isMultipleOf8AndGT0(long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"isOdd(long)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"isOffHeap()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"isOffHeap()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"isOrdered()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"isOrdered()"},{"p":"org.apache.datasketches.common","c":"Util","l":"isPowerOf2(long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"isReadOnly()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"DirectBitArrayR","l":"isReadOnly()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"isReadOnly()"},{"p":"org.apache.datasketches.quantiles","c":"CompactDoublesSketch","l":"isReadOnly()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"isReadOnly()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"isReadOnly()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"isReadOnly()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"isReadOnly()"},{"p":"org.apache.datasketches.common","c":"MemoryStatus","l":"isSameResource(Memory)","u":"isSameResource(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"isSameResource(Memory)","u":"isSameResource(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"isSameResource(Memory)","u":"isSameResource(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"isSameResource(Memory)","u":"isSameResource(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"isSameResource(Memory)","u":"isSameResource(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"isSameResource(Memory)","u":"isSameResource(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"ITEMS_SKETCH"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples","l":"items()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples","l":"items(int)"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.ItemsPair","l":"ItemsPair(T[], long[])","u":"%3Cinit%3E(T[],long[])"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"ItemsSketch(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"ItemsSketchSortedView(T[], long[], QuantilesGenericAPI<T>)","u":"%3Cinit%3E(T[],long[],org.apache.datasketches.quantilescommon.QuantilesGenericAPI)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"iterator()"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"iterator()"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"iterator()"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"iterator()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"iterator()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSketchSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"DoublesSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSketchSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"FloatsSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"ItemsSketchSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedView","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"iterator()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedView","l":"iterator()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"iterator()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples","l":"iterator()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"iterator()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"iterator()"},{"p":"org.apache.datasketches.tuple","c":"CompactSketch","l":"iterator()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"iterator()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"iterator()"},{"p":"org.apache.datasketches.theta","c":"JaccardSimilarity","l":"jaccard(Sketch, Sketch)","u":"jaccard(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"jaccard(Sketch<S>, Sketch, S, SummarySetOperations<S>)","u":"jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"jaccard(Sketch<S>, Sketch<S>, SummarySetOperations<S>)","u":"jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)"},{"p":"org.apache.datasketches.theta","c":"JaccardSimilarity","l":"JaccardSimilarity()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"JaccardSimilarity()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"SuppressFBWarnings","l":"justification()"},{"p":"org.apache.datasketches.common","c":"Family","l":"KLL"},{"p":"org.apache.datasketches.quantilescommon","c":"KolmogorovSmirnov","l":"KolmogorovSmirnov()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantilescommon","c":"KolmogorovSmirnov","l":"kolmogorovSmirnovTest(QuantilesAPI, QuantilesAPI, double)","u":"kolmogorovSmirnovTest(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch.Inequality","l":"LE"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"LE"},{"p":"org.apache.datasketches.common","c":"Util","l":"le(Object, Object, Comparator<? super T>)","u":"le(java.lang.Object,java.lang.Object,java.util.Comparator)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.PartitionBoundsRow","l":"levelPartId"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.StackElement","l":"levelPartId"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"lg()"},{"p":"org.apache.datasketches.common","c":"Util","l":"LOG2"},{"p":"org.apache.datasketches.common","c":"Util","l":"log2(double)"},{"p":"org.apache.datasketches.common","c":"Util","l":"logBaseOfX(double, double)","u":"logBaseOfX(double,double)"},{"p":"org.apache.datasketches.common","c":"Util","l":"LONG_MAX_VALUE_AS_DOUBLE"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"LONGS_SKETCH"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.LongsPair","l":"LongsPair(long[], long[])","u":"%3Cinit%3E(long[],long[])"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"LongsSketch(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSketchSortedView","l":"LongsSketchSortedView(long[], long[], QuantilesLongsAPI)","u":"%3Cinit%3E(long[],long[],org.apache.datasketches.quantilescommon.QuantilesLongsAPI)"},{"p":"org.apache.datasketches.quantilescommon","c":"LongsSortedViewIterator","l":"LongsSortedViewIterator(long[], long[])","u":"%3Cinit%3E(long[],long[])"},{"p":"org.apache.datasketches.common","c":"Util","l":"longToBytes(long, byte[])","u":"longToBytes(long,byte[])"},{"p":"org.apache.datasketches.common","c":"Util","l":"longToFixedLengthString(long, int)","u":"longToFixedLengthString(long,int)"},{"p":"org.apache.datasketches.common","c":"Util","l":"longToHexBytes(long)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.PartitionBoundsRow","l":"lowerBound"},{"p":"org.apache.datasketches.common","c":"Util","l":"LS"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch.Inequality","l":"LT"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"LT"},{"p":"org.apache.datasketches.common","c":"Util","l":"lt(Object, Object, Comparator<? super T>)","u":"lt(java.lang.Object,java.lang.Object,java.util.Comparator)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"Max"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"Max"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"MAX_K"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"MAX_LG_NOM_LONGS"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"MAX_SIZE_BITS"},{"p":"org.apache.datasketches.common","c":"Util","l":"maxT(Object, Object, Comparator<? super T>)","u":"maxT(java.lang.Object,java.lang.Object,java.util.Comparator)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"MEM_REQ_SVR_NULL_MSG"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"merge(EbppsItemsSketch<T>)","u":"merge(org.apache.datasketches.sampling.EbppsItemsSketch)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"merge(ItemsSketch<T>)","u":"merge(org.apache.datasketches.frequencies.ItemsSketch)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"merge(KllSketch)","u":"merge(org.apache.datasketches.kll.KllSketch)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"merge(KllSketch)","u":"merge(org.apache.datasketches.kll.KllSketch)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"merge(KllSketch)","u":"merge(org.apache.datasketches.kll.KllSketch)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"merge(KllSketch)","u":"merge(org.apache.datasketches.kll.KllSketch)"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"merge(KllSketch)","u":"merge(org.apache.datasketches.kll.KllSketch)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"merge(LongsSketch)","u":"merge(org.apache.datasketches.frequencies.LongsSketch)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"merge(ReqSketch)","u":"merge(org.apache.datasketches.req.ReqSketch)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"merge(TDigestDouble)","u":"merge(org.apache.datasketches.tdigest.TDigestDouble)"},{"p":"org.apache.datasketches.cpc","c":"MergingValidation","l":"MergingValidation(int, int, int, int, int, PrintStream, PrintWriter)","u":"%3Cinit%3E(int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)"},{"p":"org.apache.datasketches.common","c":"Util","l":"milliSecToString(long)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"Min"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"Min"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"MIN_LG_ARR_LONGS"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"MIN_LG_NOM_LONGS"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"minLgHashTableSize(int, double)","u":"minLgHashTableSize(int,double)"},{"p":"org.apache.datasketches.common","c":"Util","l":"minT(Object, Object, Comparator<? super T>)","u":"minT(java.lang.Object,java.lang.Object,java.util.Comparator)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"modulo(long, long, int)","u":"modulo(long,long,int)"},{"p":"org.apache.datasketches.hash","c":"MurmurHash3Adaptor","l":"modulo(long[], int)","u":"modulo(long[],int)"},{"p":"org.apache.datasketches.common","c":"Util","l":"nanoSecToString(long)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"newDirectInstance(int, WritableMemory, MemoryRequestServer)","u":"newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"newDirectInstance(int, WritableMemory, MemoryRequestServer)","u":"newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"newDirectInstance(int, WritableMemory, MemoryRequestServer)","u":"newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"newDirectInstance(WritableMemory, MemoryRequestServer)","u":"newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"newDirectInstance(WritableMemory, MemoryRequestServer)","u":"newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"newDirectInstance(WritableMemory, MemoryRequestServer)","u":"newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"newHeapInstance()"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"newHeapInstance()"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"newHeapInstance()"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"newHeapInstance(Comparator<? super T>, ArrayOfItemsSerDe<T>)","u":"newHeapInstance(java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"newHeapInstance(int)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"newHeapInstance(int)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"newHeapInstance(int)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"newHeapInstance(int, Comparator<? super T>, ArrayOfItemsSerDe<T>)","u":"newHeapInstance(int,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"newInstance(int)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"newInstance(int)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"newInstance(int)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"newInstance(int)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"newInstance(int)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"newInstance(int)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"newInstance(int, ResizeFactor)","u":"newInstance(int,org.apache.datasketches.common.ResizeFactor)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"newInstance(int, ResizeFactor)","u":"newInstance(int,org.apache.datasketches.common.ResizeFactor)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"newInstance(int, ResizeFactor)","u":"newInstance(int,org.apache.datasketches.common.ResizeFactor)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummaryFactory","l":"newSummary()"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummaryFactory","l":"newSummary()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummaryFactory","l":"newSummary()"},{"p":"org.apache.datasketches.tuple","c":"SummaryFactory","l":"newSummary()"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"newSummaryArray(S[], int)","u":"newSummaryArray(S[],int)"},{"p":"org.apache.datasketches.kll","c":"KllSketchIterator","l":"next()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchIterator","l":"next()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketchIterator","l":"next()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesSketchIterator","l":"next()"},{"p":"org.apache.datasketches.quantilescommon","c":"SortedViewIterator","l":"next()"},{"p":"org.apache.datasketches.req","c":"ReqSketchIterator","l":"next()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples.VarOptItemsIterator","l":"next()"},{"p":"org.apache.datasketches.theta","c":"HashIterator","l":"next()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketchIterator","l":"next()"},{"p":"org.apache.datasketches.tuple","c":"TupleSketchIterator","l":"next()"},{"p":"org.apache.datasketches.frequencies","c":"ErrorType","l":"NO_FALSE_NEGATIVES"},{"p":"org.apache.datasketches.frequencies","c":"ErrorType","l":"NO_FALSE_POSITIVES"},{"p":"org.apache.datasketches.common","c":"BoundsOnBinomialProportions","l":"normalCDF(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"NOT_SINGLE_ITEM_MSG"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"notB(Sketch)","u":"notB(org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"notB(Sketch)","u":"notB(org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"notB(Sketch<S>)","u":"notB(org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.common","c":"Util","l":"numberOfLeadingOnes(long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"numberOfTrailingOnes(long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"numDigits(long)"},{"p":"org.apache.datasketches.theta","c":"BitPacking","l":"packBits(long, int, byte[], int, int)","u":"packBits(long,int,byte[],int,int)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.PartitionBoundsRow","l":"part"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.StackElement","l":"part"},{"p":"org.apache.datasketches.partitions","c":"Partitioner","l":"partition(S)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.PartitionBoundsRow","l":"PartitionBoundsRow(Partitioner.StackElement<T>)","u":"%3Cinit%3E(org.apache.datasketches.partitions.Partitioner.StackElement)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner","l":"Partitioner(long, int, SketchFillRequest<T, S>)","u":"%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner","l":"Partitioner(long, int, SketchFillRequest<T, S>, QuantileSearchCriteria)","u":"%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"},{"p":"org.apache.datasketches.fdt","c":"PostProcessor","l":"PostProcessor(FdtSketch, Group, char)","u":"%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch,org.apache.datasketches.fdt.Group,char)"},{"p":"org.apache.datasketches.common","c":"Util","l":"powerSeriesNextDouble(int, double, boolean, double)","u":"powerSeriesNextDouble(int,double,boolean,double)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putDoubleBE(byte[], int, double)","u":"putDoubleBE(byte[],int,double)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putDoubleLE(byte[], int, double)","u":"putDoubleLE(byte[],int,double)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putFloatBE(byte[], int, float)","u":"putFloatBE(byte[],int,float)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putFloatLE(byte[], int, float)","u":"putFloatLE(byte[],int,float)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putIntBE(byte[], int, int)","u":"putIntBE(byte[],int,int)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putIntLE(byte[], int, int)","u":"putIntLE(byte[],int,int)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putLongBE(byte[], int, long)","u":"putLongBE(byte[],int,long)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putLongLE(byte[], int, long)","u":"putLongLE(byte[],int,long)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"putMemory(WritableMemory)","u":"putMemory(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"putMemory(WritableMemory, ArrayOfItemsSerDe<T>)","u":"putMemory(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"putMemory(WritableMemory, boolean)","u":"putMemory(org.apache.datasketches.memory.WritableMemory,boolean)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putShortBE(byte[], int, short)","u":"putShortBE(byte[],int,short)"},{"p":"org.apache.datasketches.common","c":"ByteArrayUtil","l":"putShortLE(byte[], int, short)","u":"putShortLE(byte[],int,short)"},{"p":"org.apache.datasketches.common","c":"Util","l":"pwr2SeriesNext(int, long)","u":"pwr2SeriesNext(int,long)"},{"p":"org.apache.datasketches.common","c":"Util","l":"pwr2SeriesPrev(int, int)","u":"pwr2SeriesPrev(int,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.DoublesPair","l":"quantiles"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.FloatsPair","l":"quantiles"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.ItemsPair","l":"quantiles"},{"p":"org.apache.datasketches.quantilescommon","c":"IncludeMinMax.LongsPair","l":"quantiles"},{"p":"org.apache.datasketches.common","c":"Family","l":"QUANTILES"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(byte[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(char[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(int[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(long[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(Memory)","u":"query(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(short[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"query(String)","u":"query(java.lang.String)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(byte[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(char[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(int[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(long[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(Memory)","u":"queryAndUpdate(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(short[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"queryAndUpdate(String)","u":"queryAndUpdate(java.lang.String)"},{"p":"org.apache.datasketches.cpc","c":"QuickMergingValidation","l":"QuickMergingValidation(int, int, int, PrintStream, PrintWriter)","u":"%3Cinit%3E(int,int,int,java.io.PrintStream,java.io.PrintWriter)"},{"p":"org.apache.datasketches.common","c":"Family","l":"QUICKSELECT"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer.SketchType","l":"QuickSelectSketch"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"rand"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"REBUILD_THRESHOLD"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"rebuild()"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"RejectedDuplicate"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"RejectedNullOrEmpty"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"RejectedOverTheta"},{"p":"org.apache.datasketches.common","c":"Family","l":"REQ"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"ReqSketchBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"Family","l":"RESERVOIR"},{"p":"org.apache.datasketches.common","c":"Family","l":"RESERVOIR_UNION"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"reset()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"reset()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"reset()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"reset()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"reset()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"reset()"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"reset()"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"reset()"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"reset()"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"reset()"},{"p":"org.apache.datasketches.quantiles","c":"CompactDoublesSketch","l":"reset()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"reset()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"reset()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"reset()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"reset()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"reset()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"reset()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"reset()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"reset()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"reset()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"reset()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"reset()"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"reset()"},{"p":"org.apache.datasketches.theta","c":"Union","l":"reset()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"reset()"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"reset()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesIntersection","l":"reset()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"reset()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"reset()"},{"p":"org.apache.datasketches.tuple","c":"Intersection","l":"reset()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"reset()"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"reset()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketchBuilder","l":"reset()"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"RESIZE_THRESHOLD"},{"p":"org.apache.datasketches.tdigest","c":"Sort","l":"reverse(double[], int)","u":"reverse(double[],int)"},{"p":"org.apache.datasketches.tdigest","c":"Sort","l":"reverse(long[], int)","u":"reverse(long[],int)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.PartitionBoundsRow","l":"rule"},{"p":"org.apache.datasketches.thetacommon","c":"QuickSelect","l":"select(double[], int, int, int)","u":"select(double[],int,int,int)"},{"p":"org.apache.datasketches.thetacommon","c":"QuickSelect","l":"select(long[], int, int, int)","u":"select(long[],int,int,int)"},{"p":"org.apache.datasketches.thetacommon","c":"QuickSelect","l":"selectExcludingZeros(double[], int, int)","u":"selectExcludingZeros(double[],int,int)"},{"p":"org.apache.datasketches.thetacommon","c":"QuickSelect","l":"selectExcludingZeros(long[], int, int)","u":"selectExcludingZeros(long[],int,int)"},{"p":"org.apache.datasketches.thetacommon","c":"QuickSelect","l":"selectIncludingZeros(double[], int)","u":"selectIncludingZeros(double[],int)"},{"p":"org.apache.datasketches.thetacommon","c":"QuickSelect","l":"selectIncludingZeros(long[], int)","u":"selectIncludingZeros(long[],int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"SELF_MERGE_MSG"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer","l":"SerializerDeserializer()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"serializeToByteArray(Boolean)","u":"serializeToByteArray(java.lang.Boolean)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"serializeToByteArray(Boolean[])","u":"serializeToByteArray(java.lang.Boolean[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"serializeToByteArray(Double)","u":"serializeToByteArray(java.lang.Double)"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"serializeToByteArray(Double[])","u":"serializeToByteArray(java.lang.Double[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"serializeToByteArray(Long)","u":"serializeToByteArray(java.lang.Long)"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"serializeToByteArray(Long[])","u":"serializeToByteArray(java.lang.Long[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"serializeToByteArray(Number)","u":"serializeToByteArray(java.lang.Number)"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"serializeToByteArray(Number[])","u":"serializeToByteArray(java.lang.Number[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"serializeToByteArray(String)","u":"serializeToByteArray(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"serializeToByteArray(String)","u":"serializeToByteArray(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"serializeToByteArray(String[])","u":"serializeToByteArray(java.lang.String[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"serializeToByteArray(String[])","u":"serializeToByteArray(java.lang.String[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"serializeToByteArray(T)"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"serializeToByteArray(T[])"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"serializeToString()"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"setA(Sketch)","u":"setA(org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"setA(Sketch<S>)","u":"setA(org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples","l":"setClass(Class<?>)","u":"setClass(java.lang.Class)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setFamily(Family)","u":"setFamily(org.apache.datasketches.common.Family)"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"setHighRankAccuracy(boolean)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchBuilder","l":"setK(int)"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"setK(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setLocalLogNominalEntries(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setLocalNominalEntries(int)"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"setLogNominalEntries(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setLogNominalEntries(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setMaxConcurrencyError(double)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnionBuilder","l":"setMaxK(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setMaxNumLocalThreads(int)"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"setMemoryRequestServer(MemoryRequestServer)","u":"setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setMemoryRequestServer(MemoryRequestServer)","u":"setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"setNominalEntries(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setNominalEntries(int)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"setNominalEntries(int)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"setNominalEntries(int)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketchBuilder","l":"setNominalEntries(int)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"setNumberOfValues(int)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"setNumberOfValues(int)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setNumPoolThreads(int)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"setOperationBuilder()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"SetOperationBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases","l":"SetOperationCornerCases()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"setP(float)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setP(float)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setPropagateOrderedCompact(boolean)"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"setReqDebug(ReqDebug)","u":"setReqDebug(org.apache.datasketches.req.ReqDebug)"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"setResizeFactor(ResizeFactor)","u":"setResizeFactor(org.apache.datasketches.common.ResizeFactor)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setResizeFactor(ResizeFactor)","u":"setResizeFactor(org.apache.datasketches.common.ResizeFactor)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"setResizeFactor(ResizeFactor)","u":"setResizeFactor(org.apache.datasketches.common.ResizeFactor)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketchBuilder","l":"setResizeFactor(ResizeFactor)","u":"setResizeFactor(org.apache.datasketches.common.ResizeFactor)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"setSamplingProbability(float)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketchBuilder","l":"setSamplingProbability(float)"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"setSeed(long)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"setSeed(long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSetOperationBuilder","l":"setSeed(long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketchBuilder","l":"setSeed(long)"},{"p":"org.apache.datasketches.theta","c":"JaccardSimilarity","l":"similarityTest(Sketch, Sketch, double)","u":"similarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"similarityTest(Sketch<S>, Sketch, S, SummarySetOperations<S>, double)","u":"similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)"},{"p":"org.apache.datasketches.tuple","c":"JaccardSimilarity","l":"similarityTest(Sketch<S>, Sketch<S>, SummarySetOperations<S>, double)","u":"similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"sizeOf(Boolean)","u":"sizeOf(java.lang.Boolean)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"sizeOf(Boolean[])","u":"sizeOf(java.lang.Boolean[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"sizeOf(Double)","u":"sizeOf(java.lang.Double)"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"sizeOf(Double[])","u":"sizeOf(java.lang.Double[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"sizeOf(Long)","u":"sizeOf(java.lang.Long)"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"sizeOf(Long[])","u":"sizeOf(java.lang.Long[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"sizeOf(Memory, long, int)","u":"sizeOf(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"sizeOf(Memory, long, int)","u":"sizeOf(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"sizeOf(Memory, long, int)","u":"sizeOf(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"sizeOf(Memory, long, int)","u":"sizeOf(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"sizeOf(Memory, long, int)","u":"sizeOf(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"sizeOf(Memory, long, int)","u":"sizeOf(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"sizeOf(Memory, long, int)","u":"sizeOf(org.apache.datasketches.memory.Memory,long,int)"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"sizeOf(Number)","u":"sizeOf(java.lang.Number)"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"sizeOf(Number[])","u":"sizeOf(java.lang.Number[])"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"sizeOf(String)","u":"sizeOf(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"sizeOf(String)","u":"sizeOf(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"sizeOf(T)"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"sizeOf(T[])"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"SKETCH_A"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"SKETCH_A"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"SKETCH_B"},{"p":"org.apache.datasketches.tuple","c":"Sketches","l":"Sketches()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"SketchesArgumentException","l":"SketchesArgumentException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"SketchesException","l":"SketchesException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"SketchesException","l":"SketchesException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.datasketches.common","c":"SketchesReadOnlyException","l":"SketchesReadOnlyException()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"SketchesReadOnlyException","l":"SketchesReadOnlyException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"SketchesStateException","l":"SketchesStateException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases","l":"sketchStateId(boolean, int, long)","u":"sketchStateId(boolean,int,long)"},{"p":"org.apache.datasketches.tdigest","c":"Sort","l":"Sort()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tdigest","c":"Sort","l":"stableSort(double[], long[], int)","u":"stableSort(double[],long[],int)"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.StackElement","l":"StackElement(GenericPartitionBoundaries<T>, int, String)","u":"%3Cinit%3E(org.apache.datasketches.quantilescommon.GenericPartitionBoundaries,int,java.lang.String)"},{"p":"org.apache.datasketches.cpc","c":"CompressionCharacterization","l":"start()"},{"p":"org.apache.datasketches.cpc","c":"MergingValidation","l":"start()"},{"p":"org.apache.datasketches.cpc","c":"QuickMergingValidation","l":"start()"},{"p":"org.apache.datasketches.cpc","c":"StreamingValidation","l":"start()"},{"p":"org.apache.datasketches.thetacommon","c":"ThetaUtil","l":"startingSubMultiple(int, int, int)","u":"startingSubMultiple(int,int,int)"},{"p":"org.apache.datasketches.cpc","c":"StreamingValidation","l":"StreamingValidation(int, int, int, int, PrintStream, PrintWriter)","u":"%3Cinit%3E(int,int,int,int,java.io.PrintStream,java.io.PrintWriter)"},{"p":"org.apache.datasketches.thetacommon","c":"HashOperations","l":"STRIDE_MASK"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"stringArrHash(String[])","u":"stringArrHash(java.lang.String[])"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"stringConcat(String[])","u":"stringConcat(java.lang.String[])"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"stringHash(String)","u":"stringHash(java.lang.String)"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"stringToByteArray(String)","u":"stringToByteArray(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"Family","l":"stringToFamily(String)","u":"stringToFamily(java.lang.String)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"suggestNumFilterBits(long, double)","u":"suggestNumFilterBits(long,double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"suggestNumHashes(double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilterBuilder","l":"suggestNumHashes(long, long)","u":"suggestNumHashes(long,long)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"Sum"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"Sum"},{"p":"org.apache.datasketches.common","c":"Util","l":"TAB"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesUtil","l":"tailRoundingFactor"},{"p":"org.apache.datasketches.common","c":"Family","l":"TDIGEST"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"TDigestDouble()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"TDigestDouble(short)","u":"%3Cinit%3E(short)"},{"p":"org.apache.datasketches.cpc","c":"TestUtil","l":"TestUtil()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"TGT_IS_READ_ONLY_MSG"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"toByteArray()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"toByteArray()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"toByteArray()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"toByteArray()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"toByteArray()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"toByteArray()"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"toByteArray()"},{"p":"org.apache.datasketches.theta","c":"Intersection","l":"toByteArray()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"toByteArray()"},{"p":"org.apache.datasketches.theta","c":"Union","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple","c":"CompactSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummary","l":"toByteArray()"},{"p":"org.apache.datasketches.tuple","c":"Summary","l":"toByteArray()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<? super T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<? super T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<? super T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<? super T>, Class<?>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<? super T>, Class<?>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<? super T>, Class<?>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"toByteArray(ArrayOfItemsSerDe<T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"toByteArray(ArrayOfItemsSerDe<T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"toByteArray(ArrayOfItemsSerDe<T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"toByteArray(ArrayOfItemsSerDe<T>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"toByteArray(ArrayOfItemsSerDe<T>, Class<?>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"toByteArray(ArrayOfItemsSerDe<T>, Class<?>)","u":"toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"toByteArray(boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"toByteArray(boolean, ArrayOfItemsSerDe<T>)","u":"toByteArray(boolean,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"toByteArrayCompressed()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"toCompactByteArray()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"toCompactByteArray()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"toLongArray()"},{"p":"org.apache.datasketches.common","c":"Family","l":"toString()"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"toString()"},{"p":"org.apache.datasketches.fdt","c":"Group","l":"toString()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"DirectBitArrayR","l":"toString()"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"toString()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch.Row","l":"toString()"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"toString()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch.Row","l":"toString()"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"toString()"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"toString()"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"toString()"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"toString()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"toString()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketchBuilder","l":"toString()"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"toString()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"toString()"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"toString()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"toString()"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"toString()"},{"p":"org.apache.datasketches.req","c":"ReqSketchBuilder","l":"toString()"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"toString()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"toString()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"toString()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"toString()"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"toString()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"toString()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"toString()"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"toString()"},{"p":"org.apache.datasketches.theta","c":"SetOperationBuilder","l":"toString()"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"toString()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"toString()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"toString()"},{"p":"org.apache.datasketches.tuple","c":"Sketch","l":"toString()"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"toString(boolean)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"toString(boolean)"},{"p":"org.apache.datasketches.common","c":"ArrayOfBooleansSerDe","l":"toString(Boolean)","u":"toString(java.lang.Boolean)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.kll","c":"KllSketch","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"toString(boolean, boolean)","u":"toString(boolean,boolean)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"toString(boolean, boolean, boolean)","u":"toString(boolean,boolean,boolean)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"toString(boolean, boolean, boolean, boolean)","u":"toString(boolean,boolean,boolean,boolean)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"toString(boolean, boolean, boolean, boolean)","u":"toString(boolean,boolean,boolean,boolean)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"toString(boolean, boolean, int, boolean)","u":"toString(boolean,boolean,int,boolean)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"toString(byte[])"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"toString(byte[], boolean)","u":"toString(byte[],boolean)"},{"p":"org.apache.datasketches.common","c":"ArrayOfDoublesSerDe","l":"toString(Double)","u":"toString(java.lang.Double)"},{"p":"org.apache.datasketches.common","c":"ArrayOfLongsSerDe","l":"toString(Long)","u":"toString(java.lang.Long)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"toString(Memory)","u":"toString(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"toString(Memory, boolean)","u":"toString(org.apache.datasketches.memory.Memory,boolean)"},{"p":"org.apache.datasketches.common","c":"ArrayOfNumbersSerDe","l":"toString(Number)","u":"toString(java.lang.Number)"},{"p":"org.apache.datasketches.common","c":"ArrayOfStringsSerDe","l":"toString(String)","u":"toString(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ArrayOfUtf16StringsSerDe","l":"toString(String)","u":"toString(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ArrayOfItemsSerDe","l":"toString(T)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"toUpdatableByteArray()"},{"p":"org.apache.datasketches.hll","c":"Union","l":"toUpdatableByteArray()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"TRIM_A"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"TRIM_A"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"TRIM_B"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"trim()"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"trim()"},{"p":"org.apache.datasketches.common","c":"Family","l":"TUPLE"},{"p":"org.apache.datasketches.common","c":"Family","l":"UNION"},{"p":"org.apache.datasketches.hll","c":"Union","l":"Union()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.theta","c":"Union","l":"Union()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"union(ArrayOfDoublesSketch)","u":"union(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummarySetOperations","l":"union(ArrayOfStringsSummary, ArrayOfStringsSummary)","u":"union(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"union(BloomFilter)","u":"union(org.apache.datasketches.filters.bloomfilter.BloomFilter)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"union(DoublesSketch)","u":"union(org.apache.datasketches.quantiles.DoublesSketch)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummarySetOperations","l":"union(DoubleSummary, DoubleSummary)","u":"union(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"Union(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"Union(int, SummarySetOperations<S>)","u":"%3Cinit%3E(int,org.apache.datasketches.tuple.SummarySetOperations)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"Union(int, WritableMemory)","u":"%3Cinit%3E(int,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummarySetOperations","l":"union(IntegerSummary, IntegerSummary)","u":"union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"union(ItemsSketch<T>)","u":"union(org.apache.datasketches.quantiles.ItemsSketch)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"union(Memory)","u":"union(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"union(Memory)","u":"union(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"union(Memory, ArrayOfItemsSerDe<T>)","u":"union(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.tuple","c":"SummarySetOperations","l":"union(S, S)","u":"union(S,S)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"union(Sketch)","u":"union(org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"union(Sketch, S)","u":"union(org.apache.datasketches.theta.Sketch,S)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"union(Sketch, Sketch)","u":"union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"union(Sketch, Sketch, boolean, WritableMemory)","u":"union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"union(Sketch<S>)","u":"union(org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"union(Sketch<S>, Sketch, S)","u":"union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"union(Sketch<S>, Sketch<S>)","u":"union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"},{"p":"org.apache.datasketches.tuple","c":"Union","l":"Union(SummarySetOperations<S>)","u":"%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"UniqueCountMap(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"UniqueCountMap(int, int)","u":"%3Cinit%3E(int,int)"},{"p":"org.apache.datasketches.theta","c":"BitPacking","l":"unpackBits(long[], int, int, byte[], int, int)","u":"unpackBits(long[],int,int,byte[],int,int)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesAPI","l":"UNSUPPORTED_MSG"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"UPDATABLE"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"UpdatableSketch(int, int, float, SummaryFactory<S>)","u":"%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.SummaryFactory)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"UpdatableSketch(Memory, SummaryDeserializer<S>, SummaryFactory<S>)","u":"%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"UpdatableSketch(UpdatableSketch<U, S>)","u":"%3Cinit%3E(org.apache.datasketches.tuple.UpdatableSketch)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketchBuilder","l":"UpdatableSketchBuilder(SummaryFactory<S>)","u":"%3Cinit%3E(org.apache.datasketches.tuple.SummaryFactory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesAnotB","l":"update(ArrayOfDoublesSketch, ArrayOfDoublesSketch)","u":"update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesAnotBImpl","l":"update(ArrayOfDoublesSketch, ArrayOfDoublesSketch)","u":"update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(byte[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(byte[])"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(byte[])"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(byte[])"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(byte[])"},{"p":"org.apache.datasketches.hllmap","c":"UniqueCountMap","l":"update(byte[], byte[])","u":"update(byte[],byte[])"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"update(byte[], double[])","u":"update(byte[],double[])"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"update(byte[], U)","u":"update(byte[],U)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(ByteBuffer)","u":"update(java.nio.ByteBuffer)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(ByteBuffer)","u":"update(java.nio.ByteBuffer)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(ByteBuffer)","u":"update(java.nio.ByteBuffer)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(ByteBuffer)","u":"update(java.nio.ByteBuffer)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"update(ByteBuffer, double[])","u":"update(java.nio.ByteBuffer,double[])"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"update(ByteBuffer, U)","u":"update(java.nio.ByteBuffer,U)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(char[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(char[])"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(char[])"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(char[])"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(char[])"},{"p":"org.apache.datasketches.cpc","c":"CpcUnion","l":"update(CpcSketch)","u":"update(org.apache.datasketches.cpc.CpcSketch)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(double)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(double)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(double)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"update(double)"},{"p":"org.apache.datasketches.quantiles","c":"CompactDoublesSketch","l":"update(double)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"update(double)"},{"p":"org.apache.datasketches.quantiles","c":"UpdateDoublesSketch","l":"update(double)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesDoublesAPI","l":"update(double)"},{"p":"org.apache.datasketches.tdigest","c":"TDigestDouble","l":"update(double)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(double)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(double)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary","l":"update(Double)","u":"update(java.lang.Double)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"update(double, double[])","u":"update(double,double[])"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"update(double, long)","u":"update(double,long)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"update(double, U)","u":"update(double,U)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"update(double[], int, int)","u":"update(double[],int,int)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"update(float)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesFloatsAPI","l":"update(float)"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"update(float)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"update(float, long)","u":"update(float,long)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"update(float[], int, int)","u":"update(float[],int,int)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"update(HllSketch)","u":"update(org.apache.datasketches.hll.HllSketch)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(int[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(int[])"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(int[])"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(int[])"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(int[])"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"update(int[], double[])","u":"update(int[],double[])"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"update(int[], U)","u":"update(int[],U)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary","l":"update(Integer)","u":"update(java.lang.Integer)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(long)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"update(long)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(long)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"update(long)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesLongsAPI","l":"update(long)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsSketch","l":"update(long)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"update(long)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(long)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(long)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSketch","l":"update(long, Double)","u":"update(long,java.lang.Double)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"update(long, double[])","u":"update(long,double[])"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"update(long, int, ArrayList<T>)","u":"update(long,int,java.util.ArrayList)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSketch","l":"update(long, Integer)","u":"update(long,java.lang.Integer)"},{"p":"org.apache.datasketches.frequencies","c":"LongsSketch","l":"update(long, long)","u":"update(long,long)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"update(long, long)","u":"update(long,long)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"update(long, U)","u":"update(long,U)"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(long[])"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(long[])"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(long[])"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(long[])"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(long[])"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"update(long[], double[])","u":"update(long[],double[])"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"update(long[], int, int)","u":"update(long[],int,int)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"update(long[], U)","u":"update(long[],U)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(Memory)","u":"update(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"update(Memory)","u":"update(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"update(Memory, ArrayOfItemsSerDe<T>)","u":"update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"update(Memory, ArrayOfItemsSerDe<T>)","u":"update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"update(ReservoirItemsSketch<T>)","u":"update(org.apache.datasketches.sampling.ReservoirItemsSketch)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"update(ReservoirItemsSketch<T>)","u":"update(org.apache.datasketches.sampling.ReservoirItemsSketch)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirLongsUnion","l":"update(ReservoirLongsSketch)","u":"update(org.apache.datasketches.sampling.ReservoirLongsSketch)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(short[])"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"update(String)","u":"update(java.lang.String)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"update(String)","u":"update(java.lang.String)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"update(String)","u":"update(java.lang.String)"},{"p":"org.apache.datasketches.theta","c":"Union","l":"update(String)","u":"update(java.lang.String)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"update(String)","u":"update(java.lang.String)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSketch","l":"update(String, Double)","u":"update(java.lang.String,java.lang.Double)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"update(String, double[])","u":"update(java.lang.String,double[])"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSketch","l":"update(String, Integer)","u":"update(java.lang.String,java.lang.Integer)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSketch","l":"update(String, U)","u":"update(java.lang.String,U)"},{"p":"org.apache.datasketches.fdt","c":"FdtSketch","l":"update(String[])","u":"update(java.lang.String[])"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSummary","l":"update(String[])","u":"update(java.lang.String[])"},{"p":"org.apache.datasketches.tuple.strings","c":"ArrayOfStringsSketch","l":"update(String[], String[])","u":"update(java.lang.String[],java.lang.String[])"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"update(T)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"update(T)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsSketch","l":"update(T)"},{"p":"org.apache.datasketches.quantiles","c":"ItemsUnion","l":"update(T)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantilesGenericAPI","l":"update(T)"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"update(T)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsSketch","l":"update(T)"},{"p":"org.apache.datasketches.sampling","c":"ReservoirItemsUnion","l":"update(T)"},{"p":"org.apache.datasketches.sampling","c":"EbppsItemsSketch","l":"update(T, double)","u":"update(T,double)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSketch","l":"update(T, double)","u":"update(T,double)"},{"p":"org.apache.datasketches.frequencies","c":"ItemsSketch","l":"update(T, long)","u":"update(T,long)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"update(T, long)","u":"update(T,long)"},{"p":"org.apache.datasketches.tuple","c":"UpdatableSummary","l":"update(U)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsUnion","l":"update(VarOptItemsSketch<T>)","u":"update(org.apache.datasketches.sampling.VarOptItemsSketch)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"updateSketchBuilder()"},{"p":"org.apache.datasketches.theta","c":"UpdateSketchBuilder","l":"UpdateSketchBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.partitions","c":"Partitioner.PartitionBoundsRow","l":"upperBound"},{"p":"org.apache.datasketches.tuple","c":"Util","l":"Util()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.cpc","c":"CpcSketch","l":"validate()"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer","l":"validateFamily(byte, byte)","u":"validateFamily(byte,byte)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericSortedView","l":"validateItems(T[], Comparator<? super T>)","u":"validateItems(T[],java.util.Comparator)"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer","l":"validateType(byte, SerializerDeserializer.SketchType)","u":"validateType(byte,org.apache.datasketches.tuple.SerializerDeserializer.SketchType)"},{"p":"org.apache.datasketches.common","c":"SuppressFBWarnings","l":"value()"},{"p":"org.apache.datasketches.common","c":"Family","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.frequencies","c":"ErrorType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.hll","c":"TgtHllType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.partitions","c":"BoundsRule","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch.Inequality","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantileSearchCriteria","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.IntersectAction","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer.SketchType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.datasketches.common","c":"Family","l":"values()"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"values()"},{"p":"org.apache.datasketches.frequencies","c":"ErrorType","l":"values()"},{"p":"org.apache.datasketches.hll","c":"TgtHllType","l":"values()"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchStructure","l":"values()"},{"p":"org.apache.datasketches.kll","c":"KllSketch.SketchType","l":"values()"},{"p":"org.apache.datasketches.partitions","c":"BoundsRule","l":"values()"},{"p":"org.apache.datasketches.quantilescommon","c":"GenericInequalitySearch.Inequality","l":"values()"},{"p":"org.apache.datasketches.quantilescommon","c":"InequalitySearch","l":"values()"},{"p":"org.apache.datasketches.quantilescommon","c":"QuantileSearchCriteria","l":"values()"},{"p":"org.apache.datasketches.theta","c":"UpdateReturnState","l":"values()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.AnotbAction","l":"values()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.CornerCase","l":"values()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.IntersectAction","l":"values()"},{"p":"org.apache.datasketches.thetacommon","c":"SetOperationCornerCases.UnionAction","l":"values()"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"values()"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"values()"},{"p":"org.apache.datasketches.tuple","c":"SerializerDeserializer.SketchType","l":"values()"},{"p":"org.apache.datasketches.common","c":"Family","l":"VAROPT"},{"p":"org.apache.datasketches.common","c":"Family","l":"VAROPT_UNION"},{"p":"org.apache.datasketches.req","c":"ReqSketch","l":"viewCompactorDetail(String, boolean)","u":"viewCompactorDetail(java.lang.String,boolean)"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples","l":"weights()"},{"p":"org.apache.datasketches.sampling","c":"VarOptItemsSamples","l":"weights(int)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesSketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"wrap(Memory)","u":"wrap(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.kll","c":"KllItemsSketch","l":"wrap(Memory, Comparator<? super T>, ArrayOfItemsSerDe<T>)","u":"wrap(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"},{"p":"org.apache.datasketches.theta","c":"CompactSketch","l":"wrap(Memory, long)","u":"wrap(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"wrap(Memory, long)","u":"wrap(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketch","l":"wrap(Memory, long)","u":"wrap(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketch","l":"wrap(Memory, long)","u":"wrap(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"wrap(Memory, long)","u":"wrap(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.quantiles","c":"DoublesUnion","l":"wrap(WritableMemory)","u":"wrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.quantiles","c":"UpdateDoublesSketch","l":"wrap(WritableMemory)","u":"wrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"wrap(WritableMemory)","u":"wrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"wrap(WritableMemory)","u":"wrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"wrap(WritableMemory)","u":"wrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"wrap(WritableMemory)","u":"wrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"SetOperation","l":"wrap(WritableMemory, long)","u":"wrap(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.theta","c":"UpdateSketch","l":"wrap(WritableMemory, long)","u":"wrap(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUnion","l":"wrap(WritableMemory, long)","u":"wrap(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesUpdatableSketch","l":"wrap(WritableMemory, long)","u":"wrap(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapCompactSketch(Memory)","u":"wrapCompactSketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapCompactSketch(Memory, long)","u":"wrapCompactSketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapIntersection(Memory)","u":"wrapIntersection(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapIntersection(WritableMemory)","u":"wrapIntersection(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapSetOperation(Memory)","u":"wrapSetOperation(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapSetOperation(Memory, long)","u":"wrapSetOperation(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapSetOperation(WritableMemory)","u":"wrapSetOperation(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapSetOperation(WritableMemory, long)","u":"wrapSetOperation(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapSketch(Memory)","u":"wrapSketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapSketch(Memory)","u":"wrapSketch(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapSketch(Memory, long)","u":"wrapSketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapSketch(Memory, long)","u":"wrapSketch(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapUnion(Memory)","u":"wrapUnion(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapUnion(Memory)","u":"wrapUnion(org.apache.datasketches.memory.Memory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapUnion(Memory, long)","u":"wrapUnion(org.apache.datasketches.memory.Memory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapUnion(WritableMemory)","u":"wrapUnion(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapUnion(WritableMemory)","u":"wrapUnion(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapUnion(WritableMemory, long)","u":"wrapUnion(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapUpdatableSketch(WritableMemory)","u":"wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","c":"ArrayOfDoublesSketches","l":"wrapUpdatableSketch(WritableMemory, long)","u":"wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapUpdateSketch(WritableMemory)","u":"wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.theta","c":"Sketches","l":"wrapUpdateSketch(WritableMemory, long)","u":"wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory,long)"},{"p":"org.apache.datasketches.filters.bloomfilter","c":"BloomFilter","l":"writableWrap(WritableMemory)","u":"writableWrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.hll","c":"HllSketch","l":"writableWrap(WritableMemory)","u":"writableWrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.hll","c":"Union","l":"writableWrap(WritableMemory)","u":"writableWrap(org.apache.datasketches.memory.WritableMemory)"},{"p":"org.apache.datasketches.kll","c":"KllDoublesSketch","l":"writableWrap(WritableMemory, MemoryRequestServer)","u":"writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllFloatsSketch","l":"writableWrap(WritableMemory, MemoryRequestServer)","u":"writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.kll","c":"KllLongsSketch","l":"writableWrap(WritableMemory, MemoryRequestServer)","u":"writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"X1"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"X2"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"X4"},{"p":"org.apache.datasketches.common","c":"ResizeFactor","l":"X8"},{"p":"org.apache.datasketches.hash","c":"XxHash","l":"XxHash()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.common","c":"Util","l":"zeroPad(String, int)","u":"zeroPad(java.lang.String,int)"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/7.0.X/module-search-index.js b/docs/7.0.X/module-search-index.js new file mode 100644 index 000000000..0d59754fc --- /dev/null +++ b/docs/7.0.X/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/7.0.X/org/apache/datasketches/common/ArrayOfBooleansSerDe.html b/docs/7.0.X/org/apache/datasketches/common/ArrayOfBooleansSerDe.html new file mode 100644 index 000000000..608d564d3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ArrayOfBooleansSerDe.html @@ -0,0 +1,393 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfBooleansSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ArrayOfBooleansSerDe"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfBooleansSerDe.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ArrayOfBooleansSerDe" class="title">Class ArrayOfBooleansSerDe</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>> +<div class="inheritance">org.apache.datasketches.common.ArrayOfBooleansSerDe</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfBooleansSerDe</span> +<span class="extends-implements">extends <a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span></div> +<div class="block">Methods of serializing and deserializing arrays of Boolean as a bit array.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfBooleansSerDe</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeBytesNeeded(int)" class="member-name-link">computeBytesNeeded</a><wbr>(int arrayLength)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes number of bytes needed for packed bit encoding of the array of booleans.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the concrete class of type T</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Boolean)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Boolean%5B%5D)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[] items)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Boolean)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Boolean%5B%5D)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[] items)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(java.lang.Boolean)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable string of an item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfBooleansSerDe</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfBooleansSerDe</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="computeBytesNeeded(int)"> +<h3>computeBytesNeeded</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">computeBytesNeeded</span><wbr><span class="parameters">(int arrayLength)</span></div> +<div class="block">Computes number of bytes needed for packed bit encoding of the array of booleans. Rounds + partial bytes up to return a whole number of bytes.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arrayLength</code> - Number of items in the array to serialize</dd> +<dt>Returns:</dt> +<dd>Number of bytes needed to encode the array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Boolean)"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize a single unserialized item to a byte array.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be serialized</dd> +<dt>Returns:</dt> +<dd>serialized representation of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Boolean[])"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - array of items to be serialized</dd> +<dt>Returns:</dt> +<dd>contiguous, serialized representation of the given array of unserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"><code>ArrayOfItemsSerDe.deserializeFromMemory(Memory, long, int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Boolean)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of a single unserialized item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Boolean[])"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - an array of items.</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the array of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(org.apache.datasketches.memory.Memory,long,int)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory. + The capacity of the given Memory can be much larger that the required size of the items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory.</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - the number of serialized items contained in the Memory</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the given number of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(java.lang.Boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#toString(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns a human readable string of an item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#toString(T)">toString</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>a human readable string of an item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span> <span class="element-name">getClassOfT</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#getClassOfT()">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the concrete class of type T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#getClassOfT()">getClassOfT</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></dd> +<dt>Returns:</dt> +<dd>the concrete class of type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ArrayOfDoublesSerDe.html b/docs/7.0.X/org/apache/datasketches/common/ArrayOfDoublesSerDe.html new file mode 100644 index 000000000..0b480f66d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ArrayOfDoublesSerDe.html @@ -0,0 +1,374 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ArrayOfDoublesSerDe"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesSerDe.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ArrayOfDoublesSerDe" class="title">Class ArrayOfDoublesSerDe</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> +<div class="inheritance">org.apache.datasketches.common.ArrayOfDoublesSerDe</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfDoublesSerDe</span> +<span class="extends-implements">extends <a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span></div> +<div class="block">Methods of serializing and deserializing arrays of Double.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesSerDe</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the concrete class of type T</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Double)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Double%5B%5D)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Double)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Double%5B%5D)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(java.lang.Double)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable string of an item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfDoublesSerDe</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfDoublesSerDe</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Double)"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize a single unserialized item to a byte array.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be serialized</dd> +<dt>Returns:</dt> +<dd>serialized representation of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Double[])"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - array of items to be serialized</dd> +<dt>Returns:</dt> +<dd>contiguous, serialized representation of the given array of unserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"><code>ArrayOfItemsSerDe.deserializeFromMemory(Memory, long, int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Double)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of a single unserialized item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Double[])"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - an array of items.</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the array of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(org.apache.datasketches.memory.Memory,long,int)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory. + The capacity of the given Memory can be much larger that the required size of the items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory.</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - the number of serialized items contained in the Memory</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the given number of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(java.lang.Double)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#toString(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns a human readable string of an item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#toString(T)">toString</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>a human readable string of an item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">getClassOfT</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#getClassOfT()">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the concrete class of type T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#getClassOfT()">getClassOfT</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Returns:</dt> +<dd>the concrete class of type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ArrayOfItemsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/ArrayOfItemsSerDe.html new file mode 100644 index 000000000..27a7d2a8f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ArrayOfItemsSerDe.html @@ -0,0 +1,353 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfItemsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ArrayOfItemsSerDe"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfItemsSerDe.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ArrayOfItemsSerDe" class="title">Class ArrayOfItemsSerDe<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.common.ArrayOfItemsSerDe<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - Type of item</dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></code>, <code><a href="ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></code>, <code><a href="ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></code>, <code><a href="ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></code>, <code><a href="ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></code>, <code><a href="ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ArrayOfItemsSerDe<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Base class for serializing and deserializing custom types.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfItemsSerDe</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the concrete class of type T</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#serializeToByteArray(T)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#serializeToByteArray(T%5B%5D)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#sizeOf(T)" class="member-name-link">sizeOf</a><wbr>(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(T%5B%5D)" class="member-name-link">sizeOf</a><wbr>(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[] items)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toString(T)" class="member-name-link">toString</a><wbr>(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a human readable string of an item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfItemsSerDe</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfItemsSerDe</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="serializeToByteArray(T)"> +<h3 id="serializeToByteArray(java.lang.Object)">serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a> item)</span></div> +<div class="block">Serialize a single unserialized item to a byte array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be serialized</dd> +<dt>Returns:</dt> +<dd>serialized representation of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(T[])"> +<h3 id="serializeToByteArray(java.lang.Object[])">serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[] items)</span></div> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>items</code> - array of items to be serialized</dd> +<dt>Returns:</dt> +<dd>contiguous, serialized representation of the given array of unserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int numItems)</span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"><code>deserializeFromMemory(Memory, long, int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(T)"> +<h3 id="sizeOf(java.lang.Object)">sizeOf</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a> item)</span></div> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of a single unserialized item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(T[])"> +<h3 id="sizeOf(java.lang.Object[])">sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>[] items)</span></div> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>items</code> - an array of items.</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the array of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(org.apache.datasketches.memory.Memory,long,int)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory. + The capacity of the given Memory can be much larger that the required size of the items.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory.</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - the number of serialized items contained in the Memory</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the given number of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(T)"> +<h3 id="toString(java.lang.Object)">toString</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a> item)</span></div> +<div class="block">Returns a human readable string of an item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>a human readable string of an item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>></span> <span class="element-name">getClassOfT</span>()</div> +<div class="block">Returns the concrete class of type T</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the concrete class of type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ArrayOfLongsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/ArrayOfLongsSerDe.html new file mode 100644 index 000000000..5fdd81a2e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ArrayOfLongsSerDe.html @@ -0,0 +1,374 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfLongsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ArrayOfLongsSerDe"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfLongsSerDe.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ArrayOfLongsSerDe" class="title">Class ArrayOfLongsSerDe</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> +<div class="inheritance">org.apache.datasketches.common.ArrayOfLongsSerDe</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfLongsSerDe</span> +<span class="extends-implements">extends <a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span></div> +<div class="block">Methods of serializing and deserializing arrays of Long.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfLongsSerDe</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the concrete class of type T</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Long)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Long%5B%5D)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Long)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Long%5B%5D)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(java.lang.Long)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable string of an item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfLongsSerDe</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfLongsSerDe</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Long)"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize a single unserialized item to a byte array.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be serialized</dd> +<dt>Returns:</dt> +<dd>serialized representation of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Long[])"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - array of items to be serialized</dd> +<dt>Returns:</dt> +<dd>contiguous, serialized representation of the given array of unserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"><code>ArrayOfItemsSerDe.deserializeFromMemory(Memory, long, int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Long)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of a single unserialized item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Long[])"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - an array of items.</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the array of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(org.apache.datasketches.memory.Memory,long,int)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory. + The capacity of the given Memory can be much larger that the required size of the items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory.</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - the number of serialized items contained in the Memory</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the given number of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(java.lang.Long)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#toString(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns a human readable string of an item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#toString(T)">toString</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>a human readable string of an item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">getClassOfT</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#getClassOfT()">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the concrete class of type T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#getClassOfT()">getClassOfT</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></dd> +<dt>Returns:</dt> +<dd>the concrete class of type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ArrayOfNumbersSerDe.html b/docs/7.0.X/org/apache/datasketches/common/ArrayOfNumbersSerDe.html new file mode 100644 index 000000000..37e4f2b49 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ArrayOfNumbersSerDe.html @@ -0,0 +1,382 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfNumbersSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ArrayOfNumbersSerDe"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfNumbersSerDe.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ArrayOfNumbersSerDe" class="title">Class ArrayOfNumbersSerDe</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>> +<div class="inheritance">org.apache.datasketches.common.ArrayOfNumbersSerDe</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfNumbersSerDe</span> +<span class="extends-implements">extends <a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></span></div> +<div class="block">Methods of serializing and deserializing arrays of the object version of primitive types of + Number. The array can be a mix of primitive object types. + + <p>This class serializes numbers with a leading byte (ASCII character) indicating the type. + The class keeps the values byte aligned, even though only 3 bits are strictly necessary to + encode one of the 6 different primitives with object types that extend Number.</p> + + <p>Classes handled are: <code>Long</code>, <code>Integer</code>, <code>Short</code>, + <code>Byte</code>, <code>Double</code>, and <code>Float</code>.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfNumbersSerDe</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the concrete class of type T</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Number)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.Number%5B%5D)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Number)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.Number%5B%5D)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(java.lang.Number)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable string of an item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfNumbersSerDe</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfNumbersSerDe</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Number)"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize a single unserialized item to a byte array.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be serialized</dd> +<dt>Returns:</dt> +<dd>serialized representation of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(java.lang.Number[])"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - array of items to be serialized</dd> +<dt>Returns:</dt> +<dd>contiguous, serialized representation of the given array of unserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"><code>ArrayOfItemsSerDe.deserializeFromMemory(Memory, long, int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Number)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of a single unserialized item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.Number[])"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the array of items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - an array of items.</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the array of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(org.apache.datasketches.memory.Memory,long,int)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory. + The capacity of the given Memory can be much larger that the required size of the items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory.</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - the number of serialized items contained in the Memory</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the given number of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(java.lang.Number)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#toString(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns a human readable string of an item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#toString(T)">toString</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>a human readable string of an item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></span> <span class="element-name">getClassOfT</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#getClassOfT()">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the concrete class of type T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#getClassOfT()">getClassOfT</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>></code></dd> +<dt>Returns:</dt> +<dd>the concrete class of type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ArrayOfStringsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/ArrayOfStringsSerDe.html new file mode 100644 index 000000000..e14563634 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ArrayOfStringsSerDe.html @@ -0,0 +1,362 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfStringsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ArrayOfStringsSerDe"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfStringsSerDe.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ArrayOfStringsSerDe" class="title">Class ArrayOfStringsSerDe</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> +<div class="inheritance">org.apache.datasketches.common.ArrayOfStringsSerDe</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfStringsSerDe</span> +<span class="extends-implements">extends <a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span></div> +<div class="block">Methods of serializing and deserializing arrays of String. + This class serializes strings in UTF-8 format, which is more compact compared to + <a href="ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common"><code>ArrayOfUtf16StringsSerDe</code></a>. In an extreme case when all strings are in ASCII, + this method is 2 times more compact, but it takes more time to encode and decode + by a factor of 1.5 to 2. + + <p>The serialization</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSerDe</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the concrete class of type T</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.String)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.String%5B%5D)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.String)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(java.lang.String)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable string of an item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.ArrayOfItemsSerDe">Methods inherited from class org.apache.datasketches.common.<a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></h3> +<code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">sizeOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfStringsSerDe</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSerDe</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="serializeToByteArray(java.lang.String)"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize a single unserialized item to a byte array.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be serialized</dd> +<dt>Returns:</dt> +<dd>serialized representation of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(java.lang.String[])"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - array of items to be serialized</dd> +<dt>Returns:</dt> +<dd>contiguous, serialized representation of the given array of unserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"><code>ArrayOfItemsSerDe.deserializeFromMemory(Memory, long, int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.String)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of a single unserialized item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(org.apache.datasketches.memory.Memory,long,int)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory. + The capacity of the given Memory can be much larger that the required size of the items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory.</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - the number of serialized items contained in the Memory</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the given number of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(java.lang.String)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#toString(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns a human readable string of an item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#toString(T)">toString</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>a human readable string of an item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getClassOfT</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#getClassOfT()">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the concrete class of type T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#getClassOfT()">getClassOfT</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Returns:</dt> +<dd>the concrete class of type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html new file mode 100644 index 000000000..138b5ceec --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html @@ -0,0 +1,360 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfUtf16StringsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ArrayOfUtf16StringsSerDe"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfUtf16StringsSerDe.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ArrayOfUtf16StringsSerDe" class="title">Class ArrayOfUtf16StringsSerDe</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> +<div class="inheritance">org.apache.datasketches.common.ArrayOfUtf16StringsSerDe</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfUtf16StringsSerDe</span> +<span class="extends-implements">extends <a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span></div> +<div class="block">Methods of serializing and deserializing arrays of String. + This class serializes strings using internal Java representation as char[], where each char + is a 16-bit code. The result is larger than one from <a href="ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common"><code>ArrayOfStringsSerDe</code></a>. + In an extreme case when all strings are in ASCII, the size is doubled. However it takes + less time to serialize and deserialize by a factor of 1.5 to 2.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfUtf16StringsSerDe</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">deserializeFromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the concrete class of type T</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.String)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize a single unserialized item to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToByteArray(java.lang.String%5B%5D)" class="member-name-link">serializeToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] items)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(java.lang.String)" class="member-name-link">sizeOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sizeOf(org.apache.datasketches.memory.Memory,long,int)" class="member-name-link">sizeOf</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(java.lang.String)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable string of an item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.ArrayOfItemsSerDe">Methods inherited from class org.apache.datasketches.common.<a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></h3> +<code><a href="ArrayOfItemsSerDe.html#sizeOf(T%5B%5D)">sizeOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfUtf16StringsSerDe</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfUtf16StringsSerDe</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="serializeToByteArray(java.lang.String)"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize a single unserialized item to a byte array.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be serialized</dd> +<dt>Returns:</dt> +<dd>serialized representation of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="serializeToByteArray(java.lang.String[])"> +<h3>serializeToByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] items)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Serialize an array of unserialized items to a byte array of contiguous serialized items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#serializeToByteArray(T%5B%5D)">serializeToByteArray</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>items</code> - array of items to be serialized</dd> +<dt>Returns:</dt> +<dd>contiguous, serialized representation of the given array of unserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at a Memory offset of zero and extending numItems.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"><code>ArrayOfItemsSerDe.deserializeFromMemory(Memory, long, int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)"> +<h3>deserializeFromMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">deserializeFromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Deserialize a contiguous sequence of serialized items from the given Memory + starting at the given Memory <i>offsetBytes</i> and extending numItems.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#deserializeFromMemory(org.apache.datasketches.memory.Memory,long,int)">deserializeFromMemory</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a contiguous sequence of serialized items</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - number of items in the contiguous serialized sequence.</dd> +<dt>Returns:</dt> +<dd>array of deserialized items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(java.lang.String)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of a single unserialized item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(T)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of a single unserialized item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sizeOf(org.apache.datasketches.memory.Memory,long,int)"> +<h3>sizeOf</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">sizeOf</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + int numItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the serialized size in bytes of the number of contiguous serialized items in Memory. + The capacity of the given Memory can be much larger that the required size of the items.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#sizeOf(org.apache.datasketches.memory.Memory,long,int)">sizeOf</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory.</dd> +<dd><code>offsetBytes</code> - the starting offset in the given Memory.</dd> +<dd><code>numItems</code> - the number of serialized items contained in the Memory</dd> +<dt>Returns:</dt> +<dd>the serialized size in bytes of the given number of items.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(java.lang.String)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#toString(T)">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns a human readable string of an item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#toString(T)">toString</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - a specific item</dd> +<dt>Returns:</dt> +<dd>a human readable string of an item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getClassOfT</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfItemsSerDe.html#getClassOfT()">ArrayOfItemsSerDe</a></code></span></div> +<div class="block">Returns the concrete class of type T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfItemsSerDe.html#getClassOfT()">getClassOfT</a></code> in class <code><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> +<dt>Returns:</dt> +<dd>the concrete class of type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/BoundsOnBinomialProportions.html b/docs/7.0.X/org/apache/datasketches/common/BoundsOnBinomialProportions.html new file mode 100644 index 000000000..e04ae0b4c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/BoundsOnBinomialProportions.html @@ -0,0 +1,322 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BoundsOnBinomialProportions (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: BoundsOnBinomialProportions"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BoundsOnBinomialProportions.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class BoundsOnBinomialProportions" class="title">Class BoundsOnBinomialProportions</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.common.BoundsOnBinomialProportions</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BoundsOnBinomialProportions</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Confidence intervals for binomial proportions. + + <p>This class computes an approximation to the Clopper-Pearson confidence interval + for a binomial proportion. Exact Clopper-Pearson intervals are strictly + conservative, but these approximations are not.</p> + + <p>The main inputs are numbers <i>n</i> and <i>k</i>, which are not the same as other things + that are called <i>n</i> and <i>k</i> in our sketching library. There is also a third + parameter, numStdDev, that specifies the desired confidence level.</p> + <ul> + <li><i>n</i> is the number of independent randomized trials. It is given and therefore known.</li> + <li><i>p</i> is the probability of a trial being a success. It is unknown.</li> + <li><i>k</i> is the number of trials (out of <i>n</i>) that turn out to be successes. It is + a random variable governed by a binomial distribution. After any given + batch of <i>n</i> independent trials, the random variable <i>k</i> has a specific + value which is observed and is therefore known.</li> + <li><i>pHat</i> = <i>k</i> / <i>n</i> is an unbiased estimate of the unknown success + probability <i>p</i>.</li> + </ul> + + <p>Alternatively, consider a coin with unknown heads probability <i>p</i>. Where + <i>n</i> is the number of independent flips of that coin, and <i>k</i> is the number + of times that the coin comes up heads during a given batch of <i>n</i> flips. + This class computes a frequentist confidence interval [lowerBoundOnP, upperBoundOnP] for the + unknown <i>p</i>.</p> + + <p>Conceptually, the desired confidence level is specified by a tail probability delta.</p> + + <p>Ideally, over a large ensemble of independent batches of trials, + the fraction of batches in which the true <i>p</i> lies below lowerBoundOnP would be at most + delta, and the fraction of batches in which the true <i>p</i> lies above upperBoundOnP + would also be at most delta. + + <p>Setting aside the philosophical difficulties attaching to that statement, it isn't quite + true because we are approximating the Clopper-Pearson interval.</p> + + <p>Finally, we point out that in this class's interface, the confidence parameter delta is + not specified directly, but rather through a "number of standard deviations" numStdDev. + The library effectively converts that to a delta via delta = normalCDF (-1.0 * numStdDev).</p> + + <p>It is perhaps worth emphasizing that the library is NOT merely adding and subtracting + numStdDev standard deviations to the estimate. It is doing something better, that to some + extent accounts for the fact that the binomial distribution has a non-gaussian shape.</p> + + <p>In particular, it is using an approximation to the inverse of the incomplete beta function + that appears as formula 26.5.22 on page 945 of the "Handbook of Mathematical Functions" + by Abramowitz and Stegun.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#approximateLowerBoundOnP(long,long,double)" class="member-name-link">approximateLowerBoundOnP</a><wbr>(long n, + long k, + double numStdDevs)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes lower bound of approximate Clopper-Pearson confidence interval for a binomial + proportion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#approximateUpperBoundOnP(long,long,double)" class="member-name-link">approximateUpperBoundOnP</a><wbr>(long n, + long k, + double numStdDevs)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes upper bound of approximate Clopper-Pearson confidence interval for a binomial + proportion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#erf(double)" class="member-name-link">erf</a><wbr>(double x)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes an approximation to the erf() function.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#estimateUnknownP(long,long)" class="member-name-link">estimateUnknownP</a><wbr>(long n, + long k)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes an estimate of an unknown binomial proportion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalCDF(double)" class="member-name-link">normalCDF</a><wbr>(double x)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes an approximation to normalCDF(x).</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="approximateLowerBoundOnP(long,long,double)"> +<h3>approximateLowerBoundOnP</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">approximateLowerBoundOnP</span><wbr><span class="parameters">(long n, + long k, + double numStdDevs)</span></div> +<div class="block">Computes lower bound of approximate Clopper-Pearson confidence interval for a binomial + proportion. + + <p>Implementation Notes:<br> + The approximateLowerBoundOnP is defined with respect to the right tail of the binomial + distribution.</p> + <ul> + <li>We want to solve for the <i>p</i> for which sum<sub><i>j,k,n</i></sub>bino(<i>j;n,p</i>) + = delta.</li> + <li>We now restate that in terms of the left tail.</li> + <li>We want to solve for the p for which sum<sub><i>j,0,(k-1)</i></sub>bino(<i>j;n,p</i>) + = 1 - delta.</li> + <li>Define <i>x</i> = 1-<i>p</i>.</li> + <li>We want to solve for the <i>x</i> for which I<sub><i>x(n-k+1,k)</i></sub> = 1 - delta.</li> + <li>We specify 1-delta via numStdDevs through the right tail of the standard normal + distribution.</li> + <li>Smaller values of numStdDevs correspond to bigger values of 1-delta and hence to smaller + values of delta. In fact, usefully small values of delta correspond to negative values of + numStdDevs.</li> + <li>return <i>p</i> = 1-<i>x</i>.</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - is the number of trials. Must be non-negative.</dd> +<dd><code>k</code> - is the number of successes. Must be non-negative, and cannot exceed n.</dd> +<dd><code>numStdDevs</code> - the number of standard deviations defining the confidence interval</dd> +<dt>Returns:</dt> +<dd>the lower bound of the approximate Clopper-Pearson confidence interval for the + unknown success probability.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="approximateUpperBoundOnP(long,long,double)"> +<h3>approximateUpperBoundOnP</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">approximateUpperBoundOnP</span><wbr><span class="parameters">(long n, + long k, + double numStdDevs)</span></div> +<div class="block">Computes upper bound of approximate Clopper-Pearson confidence interval for a binomial + proportion. + + <p>Implementation Notes:<br> + The approximateUpperBoundOnP is defined with respect to the left tail of the binomial + distribution.</p> + <ul> + <li>We want to solve for the <i>p</i> for which sum<sub><i>j,0,k</i></sub>bino(<i>j;n,p</i>) + = delta.</li> + <li>Define <i>x</i> = 1-<i>p</i>.</li> + <li>We want to solve for the <i>x</i> for which I<sub><i>x(n-k,k+1)</i></sub> = delta.</li> + <li>We specify delta via numStdDevs through the right tail of the standard normal + distribution.</li> + <li>Bigger values of numStdDevs correspond to smaller values of delta.</li> + <li>return <i>p</i> = 1-<i>x</i>.</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - is the number of trials. Must be non-negative.</dd> +<dd><code>k</code> - is the number of successes. Must be non-negative, and cannot exceed <i>n</i>.</dd> +<dd><code>numStdDevs</code> - the number of standard deviations defining the confidence interval</dd> +<dt>Returns:</dt> +<dd>the upper bound of the approximate Clopper-Pearson confidence interval for the + unknown success probability.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="estimateUnknownP(long,long)"> +<h3>estimateUnknownP</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">estimateUnknownP</span><wbr><span class="parameters">(long n, + long k)</span></div> +<div class="block">Computes an estimate of an unknown binomial proportion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - is the number of trials. Must be non-negative.</dd> +<dd><code>k</code> - is the number of successes. Must be non-negative, and cannot exceed n.</dd> +<dt>Returns:</dt> +<dd>the estimate of the unknown binomial proportion.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="erf(double)"> +<h3>erf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">erf</span><wbr><span class="parameters">(double x)</span></div> +<div class="block">Computes an approximation to the erf() function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>x</code> - is the input to the erf function</dd> +<dt>Returns:</dt> +<dd>returns erf(x), accurate to roughly 7 decimal digits.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="normalCDF(double)"> +<h3>normalCDF</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">normalCDF</span><wbr><span class="parameters">(double x)</span></div> +<div class="block">Computes an approximation to normalCDF(x).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>x</code> - is the input to the normalCDF function</dd> +<dt>Returns:</dt> +<dd>returns the approximation to normalCDF(x).</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html b/docs/7.0.X/org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html new file mode 100644 index 000000000..f6887d13c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html @@ -0,0 +1,253 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BoundsOnRatiosInSampledSets (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: BoundsOnRatiosInSampledSets"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BoundsOnRatiosInSampledSets.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class BoundsOnRatiosInSampledSets" class="title">Class BoundsOnRatiosInSampledSets</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.common.BoundsOnRatiosInSampledSets</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BoundsOnRatiosInSampledSets</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>|B| / |A|</i>, where: + <ul> + <li><i>|A|</i> is the unknown size of a set <i>A</i> of unique identifiers.</li> + <li><i>|B|</i> is the unknown size of a subset <i>B</i> of <i>A</i>.</li> + <li><i>a</i> = <i>|S<sub>A</sub>|</i> is the observed size of a sample of <i>A</i> + that was obtained by Bernoulli sampling with a known inclusion probability <i>f</i>.</li> + <li><i>b</i> = <i>|S<sub>A</sub> ∩ B|</i> is the observed size of a subset + of <i>S<sub>A</sub></i>.</li> + </ul></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfA(long,double)" class="member-name-link">getEstimateOfA</a><wbr>(long a, + double f)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the estimate of A.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfB(long,double)" class="member-name-link">getEstimateOfB</a><wbr>(long b, + double f)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the estimate of B.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfBoverA(long,long)" class="member-name-link">getEstimateOfBoverA</a><wbr>(long a, + long b)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the estimate of b over a</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLowerBoundForBoverA(long,long,double)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(long a, + long b, + double f)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the approximate lower bound based on a 95% confidence interval</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpperBoundForBoverA(long,long,double)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(long a, + long b, + double f)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the approximate upper bound based on a 95% confidence interval</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getLowerBoundForBoverA(long,long,double)"> +<h3>getLowerBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getLowerBoundForBoverA</span><wbr><span class="parameters">(long a, + long b, + double f)</span></div> +<div class="block">Return the approximate lower bound based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - See class javadoc</dd> +<dd><code>b</code> - See class javadoc</dd> +<dd><code>f</code> - the inclusion probability used to produce the set with size <i>a</i> and should + generally be less than 0.5. Above this value, the results not be reliable. + When <i>f</i> = 1.0 this returns the estimate.</dd> +<dt>Returns:</dt> +<dd>the approximate upper bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBoundForBoverA(long,long,double)"> +<h3>getUpperBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getUpperBoundForBoverA</span><wbr><span class="parameters">(long a, + long b, + double f)</span></div> +<div class="block">Return the approximate upper bound based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - See class javadoc</dd> +<dd><code>b</code> - See class javadoc</dd> +<dd><code>f</code> - the inclusion probability used to produce the set with size <i>a</i>.</dd> +<dt>Returns:</dt> +<dd>the approximate lower bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimateOfBoverA(long,long)"> +<h3>getEstimateOfBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getEstimateOfBoverA</span><wbr><span class="parameters">(long a, + long b)</span></div> +<div class="block">Return the estimate of b over a</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - See class javadoc</dd> +<dd><code>b</code> - See class javadoc</dd> +<dt>Returns:</dt> +<dd>the estimate of b over a</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimateOfA(long,double)"> +<h3>getEstimateOfA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getEstimateOfA</span><wbr><span class="parameters">(long a, + double f)</span></div> +<div class="block">Return the estimate of A. See class javadoc.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - See class javadoc</dd> +<dd><code>f</code> - the inclusion probability used to produce the set with size <i>a</i>.</dd> +<dt>Returns:</dt> +<dd>the approximate lower bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimateOfB(long,double)"> +<h3>getEstimateOfB</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getEstimateOfB</span><wbr><span class="parameters">(long b, + double f)</span></div> +<div class="block">Return the estimate of B. See class javadoc.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>b</code> - See class javadoc</dd> +<dd><code>f</code> - the inclusion probability used to produce the set with size <i>b</i>.</dd> +<dt>Returns:</dt> +<dd>the approximate lower bound</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ByteArrayUtil.html b/docs/7.0.X/org/apache/datasketches/common/ByteArrayUtil.html new file mode 100644 index 000000000..4c4b64fd7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ByteArrayUtil.html @@ -0,0 +1,677 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ByteArrayUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: ByteArrayUtil"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ByteArrayUtil.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class ByteArrayUtil" class="title">Class ByteArrayUtil</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.common.ByteArrayUtil</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ByteArrayUtil</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Useful methods for byte arrays.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ByteArrayUtil</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#copyBytes(byte%5B%5D,int,byte%5B%5D,int,int)" class="member-name-link">copyBytes</a><wbr>(byte[] source, + int srcStart, + byte[] target, + int tgtStart, + int numBytes)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Copies bytes from source to target with offsets on both the source and target.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDoubleBE(byte%5B%5D,int)" class="member-name-link">getDoubleBE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>double</i> from the given byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDoubleLE(byte%5B%5D,int)" class="member-name-link">getDoubleLE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>double</i> from the given byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getFloatBE(byte%5B%5D,int)" class="member-name-link">getFloatBE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>float</i> from the given byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getFloatLE(byte%5B%5D,int)" class="member-name-link">getFloatLE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>float</i> from the given byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getIntBE(byte%5B%5D,int)" class="member-name-link">getIntBE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>int</i> from the given byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getIntLE(byte%5B%5D,int)" class="member-name-link">getIntLE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>int</i> from the given byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLongBE(byte%5B%5D,int)" class="member-name-link">getLongBE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>long</i> from the source byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLongLE(byte%5B%5D,int)" class="member-name-link">getLongLE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>long</i> from the given byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static short</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getShortBE(byte%5B%5D,int)" class="member-name-link">getShortBE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>short</i> from the given byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static short</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getShortLE(byte%5B%5D,int)" class="member-name-link">getShortLE</a><wbr>(byte[] array, + int offset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Get a <i>short</i> from the given byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putDoubleBE(byte%5B%5D,int,double)" class="member-name-link">putDoubleBE</a><wbr>(byte[] array, + int offset, + double value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>double</i> into the destination byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putDoubleLE(byte%5B%5D,int,double)" class="member-name-link">putDoubleLE</a><wbr>(byte[] array, + int offset, + double value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>double</i> into the destination byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putFloatBE(byte%5B%5D,int,float)" class="member-name-link">putFloatBE</a><wbr>(byte[] array, + int offset, + float value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>float</i> into the destination byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putFloatLE(byte%5B%5D,int,float)" class="member-name-link">putFloatLE</a><wbr>(byte[] array, + int offset, + float value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>float</i> into the destination byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putIntBE(byte%5B%5D,int,int)" class="member-name-link">putIntBE</a><wbr>(byte[] array, + int offset, + int value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>int</i> into the destination byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putIntLE(byte%5B%5D,int,int)" class="member-name-link">putIntLE</a><wbr>(byte[] array, + int offset, + int value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>int</i> into the destination byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putLongBE(byte%5B%5D,int,long)" class="member-name-link">putLongBE</a><wbr>(byte[] array, + int offset, + long value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>long</i> into the destination byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putLongLE(byte%5B%5D,int,long)" class="member-name-link">putLongLE</a><wbr>(byte[] array, + int offset, + long value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>long</i> into the destination byte array starting at the given offset + in little endian order.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putShortBE(byte%5B%5D,int,short)" class="member-name-link">putShortBE</a><wbr>(byte[] array, + int offset, + short value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>short</i> into the destination byte array starting at the given offset + in big endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#putShortLE(byte%5B%5D,int,short)" class="member-name-link">putShortLE</a><wbr>(byte[] array, + int offset, + short value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Put the source <i>short</i> into the destination byte array starting at the given offset + in little endian order.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ByteArrayUtil</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ByteArrayUtil</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="copyBytes(byte[],int,byte[],int,int)"> +<h3>copyBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">copyBytes</span><wbr><span class="parameters">(byte[] source, + int srcStart, + byte[] target, + int tgtStart, + int numBytes)</span></div> +<div class="block">Copies bytes from source to target with offsets on both the source and target.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>source</code> - the given source</dd> +<dd><code>srcStart</code> - the source starting index</dd> +<dd><code>target</code> - the give target</dd> +<dd><code>tgtStart</code> - the target starting index</dd> +<dd><code>numBytes</code> - the number of bytes to be transferred.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getShortLE(byte[],int)"> +<h3>getShortLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">short</span> <span class="element-name">getShortLE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>short</i> from the given byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>short</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putShortLE(byte[],int,short)"> +<h3>putShortLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putShortLE</span><wbr><span class="parameters">(byte[] array, + int offset, + short value)</span></div> +<div class="block">Put the source <i>short</i> into the destination byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>short</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getShortBE(byte[],int)"> +<h3>getShortBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">short</span> <span class="element-name">getShortBE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>short</i> from the given byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>short</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putShortBE(byte[],int,short)"> +<h3>putShortBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putShortBE</span><wbr><span class="parameters">(byte[] array, + int offset, + short value)</span></div> +<div class="block">Put the source <i>short</i> into the destination byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>short</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getIntLE(byte[],int)"> +<h3>getIntLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getIntLE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>int</i> from the given byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>int</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putIntLE(byte[],int,int)"> +<h3>putIntLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putIntLE</span><wbr><span class="parameters">(byte[] array, + int offset, + int value)</span></div> +<div class="block">Put the source <i>int</i> into the destination byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>int</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getIntBE(byte[],int)"> +<h3>getIntBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getIntBE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>int</i> from the given byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>int</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putIntBE(byte[],int,int)"> +<h3>putIntBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putIntBE</span><wbr><span class="parameters">(byte[] array, + int offset, + int value)</span></div> +<div class="block">Put the source <i>int</i> into the destination byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>int</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLongLE(byte[],int)"> +<h3>getLongLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">getLongLE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>long</i> from the given byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>long</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putLongLE(byte[],int,long)"> +<h3>putLongLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putLongLE</span><wbr><span class="parameters">(byte[] array, + int offset, + long value)</span></div> +<div class="block">Put the source <i>long</i> into the destination byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>long</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLongBE(byte[],int)"> +<h3>getLongBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">getLongBE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>long</i> from the source byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source starting point</dd> +<dt>Returns:</dt> +<dd>the <i>long</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putLongBE(byte[],int,long)"> +<h3>putLongBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putLongBE</span><wbr><span class="parameters">(byte[] array, + int offset, + long value)</span></div> +<div class="block">Put the source <i>long</i> into the destination byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination starting point</dd> +<dd><code>value</code> - source <i>long</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFloatLE(byte[],int)"> +<h3>getFloatLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">float</span> <span class="element-name">getFloatLE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>float</i> from the given byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>float</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putFloatLE(byte[],int,float)"> +<h3>putFloatLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putFloatLE</span><wbr><span class="parameters">(byte[] array, + int offset, + float value)</span></div> +<div class="block">Put the source <i>float</i> into the destination byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>float</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFloatBE(byte[],int)"> +<h3>getFloatBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">float</span> <span class="element-name">getFloatBE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>float</i> from the given byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>float</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putFloatBE(byte[],int,float)"> +<h3>putFloatBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putFloatBE</span><wbr><span class="parameters">(byte[] array, + int offset, + float value)</span></div> +<div class="block">Put the source <i>float</i> into the destination byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>float</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getDoubleLE(byte[],int)"> +<h3>getDoubleLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getDoubleLE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>double</i> from the given byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>double</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putDoubleLE(byte[],int,double)"> +<h3>putDoubleLE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putDoubleLE</span><wbr><span class="parameters">(byte[] array, + int offset, + double value)</span></div> +<div class="block">Put the source <i>double</i> into the destination byte array starting at the given offset + in little endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>double</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getDoubleBE(byte[],int)"> +<h3>getDoubleBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getDoubleBE</span><wbr><span class="parameters">(byte[] array, + int offset)</span></div> +<div class="block">Get a <i>double</i> from the given byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - source byte array</dd> +<dd><code>offset</code> - source offset</dd> +<dt>Returns:</dt> +<dd>the <i>double</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putDoubleBE(byte[],int,double)"> +<h3>putDoubleBE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">putDoubleBE</span><wbr><span class="parameters">(byte[] array, + int offset, + double value)</span></div> +<div class="block">Put the source <i>double</i> into the destination byte array starting at the given offset + in big endian order. + There is no bounds checking.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>array</code> - destination byte array</dd> +<dd><code>offset</code> - destination offset</dd> +<dd><code>value</code> - source <i>double</i></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/Family.html b/docs/7.0.X/org/apache/datasketches/common/Family.html new file mode 100644 index 000000000..6e0627fba --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/Family.html @@ -0,0 +1,602 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Family (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, enum: Family"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Family.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Enum Class Family" class="title">Enum Class Family</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>> +<div class="inheritance">org.apache.datasketches.common.Family</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">Family</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>></span></div> +<div class="block">Defines the various families of sketch and set operation classes. A family defines a set of + classes that share fundamental algorithms and behaviors. The classes within a family may + still differ by how they are stored and accessed. For example, internally there are separate + classes for the QuickSelect sketch algorithm that operate on the Java heap and off-heap. + Not all of these families have parallel forms on and off-heap but are included for completeness.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#A_NOT_B" class="member-name-link">A_NOT_B</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The A and not B family is an operation for the Theta Sketch Framework of sketches.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#ALPHA" class="member-name-link">ALPHA</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Alpha Sketch family is a member of the Theta Sketch Framework of sketches and is best + suited for real-time processes where both the updating of the sketch and getting the estimate + is performed directly on the sketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="#BLOOMFILTER" class="member-name-link">BLOOMFILTER</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Bloom Filter</div> +</div> +<div class="col-first odd-row-color"><code><a href="#COMPACT" class="member-name-link">COMPACT</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Compact Sketch family is a member of the Theta Sketch Framework of sketches.</div> +</div> +<div class="col-first even-row-color"><code><a href="#COUNTMIN" class="member-name-link">COUNTMIN</a></code></div> +<div class="col-last even-row-color"> +<div class="block">CountMin Sketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="#CPC" class="member-name-link">CPC</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Compressed Probabilistic Counting (CPC) Sketch</div> +</div> +<div class="col-first even-row-color"><code><a href="#EBPPS" class="member-name-link">EBPPS</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Exact and Bounded, Probability Proportional to Size (EBPPS)</div> +</div> +<div class="col-first odd-row-color"><code><a href="#FREQUENCY" class="member-name-link">FREQUENCY</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Frequency family of sketches.</div> +</div> +<div class="col-first even-row-color"><code><a href="#HLL" class="member-name-link">HLL</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The HLL family of sketches.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#INTERSECTION" class="member-name-link">INTERSECTION</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Intersection family is an operation for the Theta Sketch Framework of sketches.</div> +</div> +<div class="col-first even-row-color"><code><a href="#KLL" class="member-name-link">KLL</a></code></div> +<div class="col-last even-row-color"> +<div class="block">KLL quantiles sketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="#QUANTILES" class="member-name-link">QUANTILES</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles family of sketches.</div> +</div> +<div class="col-first even-row-color"><code><a href="#QUICKSELECT" class="member-name-link">QUICKSELECT</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The QuickSelect Sketch family is a member of the Theta Sketch Framework of sketches and + is the workhorse of the Theta Sketch Families and can be constructed for either on-heap or + off-heap operation.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#REQ" class="member-name-link">REQ</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Relative Error Quantiles Sketch</div> +</div> +<div class="col-first even-row-color"><code><a href="#RESERVOIR" class="member-name-link">RESERVOIR</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The Reservoir family of sketches.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#RESERVOIR_UNION" class="member-name-link">RESERVOIR_UNION</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The reservoir sampling family of Union operations.</div> +</div> +<div class="col-first even-row-color"><code><a href="#TDIGEST" class="member-name-link">TDIGEST</a></code></div> +<div class="col-last even-row-color"> +<div class="block">t-Digest for estimating quantiles and ranks</div> +</div> +<div class="col-first odd-row-color"><code><a href="#TUPLE" class="member-name-link">TUPLE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Tuple family of sketches is a large family of sketches that are extensions of the + Theta Sketch Framework.</div> +</div> +<div class="col-first even-row-color"><code><a href="#UNION" class="member-name-link">UNION</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The Union family is an operation for the Theta Sketch Framework of sketches.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#VAROPT" class="member-name-link">VAROPT</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The VarOpt family of sketches.</div> +</div> +<div class="col-first even-row-color"><code><a href="#VAROPT_UNION" class="member-name-link">VAROPT_UNION</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The VarOpt family of sketches.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkFamilyID(int)" class="member-name-link">checkFamilyID</a><wbr>(int id)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamilyName()" class="member-name-link">getFamilyName</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the name for this family</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getID()" class="member-name-link">getID</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the byte ID for this family</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxPreLongs()" class="member-name-link">getMaxPreLongs</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum preamble size for this family in longs</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinPreLongs()" class="member-name-link">getMinPreLongs</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum preamble size for this family in longs</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#idToFamily(int)" class="member-name-link">idToFamily</a><wbr>(int id)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the Family given the ID</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringToFamily(java.lang.String)" class="member-name-link">stringToFamily</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> famName)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the Family given the family name</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="ALPHA"> +<h3>ALPHA</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">ALPHA</span></div> +<div class="block">The Alpha Sketch family is a member of the Theta Sketch Framework of sketches and is best + suited for real-time processes where both the updating of the sketch and getting the estimate + is performed directly on the sketch. In this situation the AlphaSketch has roughly a + 30% improvement (~1/sqrt(2*k)) in its error distribution as compared to the QuickSelect + (or similar KMV-derived) sketches. + + <p>If the AlphaSketch is fed into any SetOperation, the error distribution reverts back to the + normal QuickSelect/KMV error distribution (~1/sqrt(k)). For this reason, the AlphaSketch + does not have a sister class for off-heap operation. The Alpha Sketch has a roughly 30% faster + overall update time as compared to the QuickSelect sketch family.</p> + + <p>The Alpha Sketch is created using the UpdateSketch.builder(). + <a href="../../../../resources/dictionary.html#alphaTCF">See Alpha TCF</a> and + <a href="../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a></div> +</section> +</li> +<li> +<section class="detail" id="QUICKSELECT"> +<h3>QUICKSELECT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">QUICKSELECT</span></div> +<div class="block">The QuickSelect Sketch family is a member of the Theta Sketch Framework of sketches and + is the workhorse of the Theta Sketch Families and can be constructed for either on-heap or + off-heap operation. + The QuickSelect Sketch is created using the UpdateSketch.builder(). + <a href="../../../../resources/dictionary.html#quickSelectTCF">See Quick Select TCF</a></div> +</section> +</li> +<li> +<section class="detail" id="COMPACT"> +<h3>COMPACT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">COMPACT</span></div> +<div class="block">The Compact Sketch family is a member of the Theta Sketch Framework of sketches. + The are read-only and cannot be updated, but can participate in any of the Set Operations. + The compact sketches are never created directly with a constructor or Builder. + Instead they are created as a result of the compact() + method of an UpdateSketch or as a result of a getSketchSamples() of a SetOperation.</div> +</section> +</li> +<li> +<section class="detail" id="UNION"> +<h3>UNION</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">UNION</span></div> +<div class="block">The Union family is an operation for the Theta Sketch Framework of sketches. + The Union is constructed using the SetOperation.builder().</div> +</section> +</li> +<li> +<section class="detail" id="INTERSECTION"> +<h3>INTERSECTION</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">INTERSECTION</span></div> +<div class="block">The Intersection family is an operation for the Theta Sketch Framework of sketches. + The Intersection is constructed using the SetOperation.builder().</div> +</section> +</li> +<li> +<section class="detail" id="A_NOT_B"> +<h3>A_NOT_B</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">A_NOT_B</span></div> +<div class="block">The A and not B family is an operation for the Theta Sketch Framework of sketches. + The AnotB operation is constructed using the SetOperation.builder().</div> +</section> +</li> +<li> +<section class="detail" id="HLL"> +<h3>HLL</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">HLL</span></div> +<div class="block">The HLL family of sketches. (Not part of TSF.)</div> +</section> +</li> +<li> +<section class="detail" id="QUANTILES"> +<h3>QUANTILES</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">QUANTILES</span></div> +<div class="block">The Quantiles family of sketches. (Not part of TSF.)</div> +</section> +</li> +<li> +<section class="detail" id="TUPLE"> +<h3>TUPLE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">TUPLE</span></div> +<div class="block">The Tuple family of sketches is a large family of sketches that are extensions of the + Theta Sketch Framework.</div> +</section> +</li> +<li> +<section class="detail" id="FREQUENCY"> +<h3>FREQUENCY</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">FREQUENCY</span></div> +<div class="block">The Frequency family of sketches. (Not part of TSF.)</div> +</section> +</li> +<li> +<section class="detail" id="RESERVOIR"> +<h3>RESERVOIR</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">RESERVOIR</span></div> +<div class="block">The Reservoir family of sketches. (Not part of TSF.)</div> +</section> +</li> +<li> +<section class="detail" id="RESERVOIR_UNION"> +<h3>RESERVOIR_UNION</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">RESERVOIR_UNION</span></div> +<div class="block">The reservoir sampling family of Union operations. (Not part of TSF.)</div> +</section> +</li> +<li> +<section class="detail" id="VAROPT"> +<h3>VAROPT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">VAROPT</span></div> +<div class="block">The VarOpt family of sketches. (Not part of TSF.)</div> +</section> +</li> +<li> +<section class="detail" id="VAROPT_UNION"> +<h3>VAROPT_UNION</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">VAROPT_UNION</span></div> +<div class="block">The VarOpt family of sketches. (Not part of TSF.)</div> +</section> +</li> +<li> +<section class="detail" id="KLL"> +<h3>KLL</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">KLL</span></div> +<div class="block">KLL quantiles sketch</div> +</section> +</li> +<li> +<section class="detail" id="CPC"> +<h3>CPC</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">CPC</span></div> +<div class="block">Compressed Probabilistic Counting (CPC) Sketch</div> +</section> +</li> +<li> +<section class="detail" id="REQ"> +<h3>REQ</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">REQ</span></div> +<div class="block">Relative Error Quantiles Sketch</div> +</section> +</li> +<li> +<section class="detail" id="COUNTMIN"> +<h3>COUNTMIN</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">COUNTMIN</span></div> +<div class="block">CountMin Sketch</div> +</section> +</li> +<li> +<section class="detail" id="EBPPS"> +<h3>EBPPS</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">EBPPS</span></div> +<div class="block">Exact and Bounded, Probability Proportional to Size (EBPPS)</div> +</section> +</li> +<li> +<section class="detail" id="TDIGEST"> +<h3>TDIGEST</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">TDIGEST</span></div> +<div class="block">t-Digest for estimating quantiles and ranks</div> +</section> +</li> +<li> +<section class="detail" id="BLOOMFILTER"> +<h3>BLOOMFILTER</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">BLOOMFILTER</span></div> +<div class="block">Bloom Filter</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getID()"> +<h3>getID</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getID</span>()</div> +<div class="block">Returns the byte ID for this family</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the byte ID for this family</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkFamilyID(int)"> +<h3>checkFamilyID</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">checkFamilyID</span><wbr><span class="parameters">(int id)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>id</code> - the given id, a value < 128.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamilyName()"> +<h3>getFamilyName</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFamilyName</span>()</div> +<div class="block">Returns the name for this family</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the name for this family</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinPreLongs()"> +<h3>getMinPreLongs</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMinPreLongs</span>()</div> +<div class="block">Returns the minimum preamble size for this family in longs</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum preamble size for this family in longs</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxPreLongs()"> +<h3>getMaxPreLongs</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxPreLongs</span>()</div> +<div class="block">Returns the maximum preamble size for this family in longs</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum preamble size for this family in longs</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="idToFamily(int)"> +<h3>idToFamily</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">idToFamily</span><wbr><span class="parameters">(int id)</span></div> +<div class="block">Returns the Family given the ID</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>id</code> - the given ID</dd> +<dt>Returns:</dt> +<dd>the Family given the ID</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="stringToFamily(java.lang.String)"> +<h3>stringToFamily</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">stringToFamily</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> famName)</span></div> +<div class="block">Returns the Family given the family name</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>famName</code> - the family name</dd> +<dt>Returns:</dt> +<dd>the Family given the family name</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/MemoryStatus.html b/docs/7.0.X/org/apache/datasketches/common/MemoryStatus.html new file mode 100644 index 000000000..698aa72f7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/MemoryStatus.html @@ -0,0 +1,183 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>MemoryStatus (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, interface: MemoryStatus"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/MemoryStatus.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Interface MemoryStatus" class="title">Interface MemoryStatus</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></code>, <code><a href="../theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code>, <code><a href="../theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code>, <code><a href="../theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code>, <code><a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code>, <code><a href="../theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></code>, <code><a href="../theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">MemoryStatus</span></div> +<div class="block">Methods for inquiring the status of a backing Memory object.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns true if this object's internal data is backed by a Memory object, + which may be on-heap or off-heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns true if this object's internal data is backed by direct (off-heap) Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource</a><wbr>(org.apache.datasketches.memory.Memory that)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block">Returns true if this object's internal data is backed by a Memory object, + which may be on-heap or off-heap.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this object's internal data is backed by a Memory object.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block">Returns true if this object's internal data is backed by direct (off-heap) Memory.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this object's internal data is backed by direct (off-heap) Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isSameResource(org.apache.datasketches.memory.Memory)"> +<h3>isSameResource</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isSameResource</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory that)</span></div> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>. The capacities must be the same. If <i>this</i> is a region, + the region offset must also be the same.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>that</code> - A different non-null and alive Memory object.</dd> +<dt>Returns:</dt> +<dd>true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</dd> +<dt>Throws:</dt> +<dd><code><a href="SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></code> - if <i>that</i> is not alive (already closed).</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/ResizeFactor.html b/docs/7.0.X/org/apache/datasketches/common/ResizeFactor.html new file mode 100644 index 000000000..3a3ab5f79 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/ResizeFactor.html @@ -0,0 +1,307 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ResizeFactor (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, enum: ResizeFactor"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ResizeFactor.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Enum Class ResizeFactor" class="title">Enum Class ResizeFactor</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a>> +<div class="inheritance">org.apache.datasketches.common.ResizeFactor</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">ResizeFactor</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a>></span></div> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required. + <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#X1" class="member-name-link">X1</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Do not resize.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#X2" class="member-name-link">X2</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Resize factor is 2.</div> +</div> +<div class="col-first even-row-color"><code><a href="#X4" class="member-name-link">X4</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Resize factor is 4.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#X8" class="member-name-link">X8</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Resize factor is 8.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRF(int)" class="member-name-link">getRF</a><wbr>(int lg)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the Resize Factor given the Log-base 2 of the Resize Factor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValue()" class="member-name-link">getValue</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Resize Factor</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#lg()" class="member-name-link">lg</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Log-base 2 of the Resize Factor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="X1"> +<h3>X1</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">X1</span></div> +<div class="block">Do not resize. Sketch will be configured to full size.</div> +</section> +</li> +<li> +<section class="detail" id="X2"> +<h3>X2</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">X2</span></div> +<div class="block">Resize factor is 2.</div> +</section> +</li> +<li> +<section class="detail" id="X4"> +<h3>X4</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">X4</span></div> +<div class="block">Resize factor is 4.</div> +</section> +</li> +<li> +<section class="detail" id="X8"> +<h3>X8</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">X8</span></div> +<div class="block">Resize factor is 8.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="lg()"> +<h3>lg</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">lg</span>()</div> +<div class="block">Returns the Log-base 2 of the Resize Factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Log-base 2 of the Resize Factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRF(int)"> +<h3>getRF</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getRF</span><wbr><span class="parameters">(int lg)</span></div> +<div class="block">Returns the Resize Factor given the Log-base 2 of the Resize Factor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lg</code> - a value between zero and 3, inclusive.</dd> +<dt>Returns:</dt> +<dd>the Resize Factor given the Log-base 2 of the Resize Factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getValue()"> +<h3>getValue</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getValue</span>()</div> +<div class="block">Returns the Resize Factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Resize Factor</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/SketchesArgumentException.html b/docs/7.0.X/org/apache/datasketches/common/SketchesArgumentException.html new file mode 100644 index 000000000..c37fca67f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/SketchesArgumentException.html @@ -0,0 +1,168 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SketchesArgumentException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: SketchesArgumentException"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SketchesArgumentException.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class SketchesArgumentException" class="title">Class SketchesArgumentException</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a> +<div class="inheritance"><a href="SketchesException.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.SketchesException</a> +<div class="inheritance">org.apache.datasketches.common.SketchesArgumentException</div> +</div> +</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SketchesArgumentException</span> +<span class="extends-implements">extends <a href="SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></span></div> +<div class="block">Illegal Arguments Exception class for the library</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../serialized-form.html#org.apache.datasketches.common.SketchesArgumentException">Serialized Form</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesArgumentException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(java.lang.String)"> +<h3>SketchesArgumentException</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SketchesArgumentException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span></div> +<div class="block">Constructs a new runtime exception with the specified detail message. The cause is not + initialized, and may subsequently be initialized by a call to + Throwable.initCause(java.lang.Throwable).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>message</code> - the detail message. The detail message is saved for later retrieval by the + Throwable.getMessage() method.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/SketchesException.html b/docs/7.0.X/org/apache/datasketches/common/SketchesException.html new file mode 100644 index 000000000..79cc09c07 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/SketchesException.html @@ -0,0 +1,193 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SketchesException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: SketchesException"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SketchesException.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class SketchesException" class="title">Class SketchesException</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a> +<div class="inheritance">org.apache.datasketches.common.SketchesException</div> +</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></code>, <code><a href="SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></code>, <code><a href="SketchesStateException.html" title="class in org.apache.datasketches.common">SketchesStateException</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SketchesException</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></span></div> +<div class="block">Exception class for the library</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../serialized-form.html#org.apache.datasketches.common.SketchesException">Serialized Form</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.Throwable)" class="member-name-link">SketchesException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a new runtime exception with the specified detail message and cause.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(java.lang.String)"> +<h3>SketchesException</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SketchesException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span></div> +<div class="block">Constructs a new runtime exception with the specified detail message. The cause is not + initialized, and may subsequently be initialized by a call to + Throwable.initCause(java.lang.Throwable).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>message</code> - the detail message. The detail message is saved for later retrieval by the + Throwable.getMessage() method.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(java.lang.String,java.lang.Throwable)"> +<h3>SketchesException</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SketchesException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</span></div> +<div class="block">Constructs a new runtime exception with the specified detail message and cause. + + <p>Note that the detail message associated with cause is not automatically incorporated + in this runtime exception's detail message.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>message</code> - the detail message (which is saved for later retrieval by the + Throwable.getMessage() method).</dd> +<dd><code>cause</code> - the cause (which is saved for later retrieval by the Throwable.getCause() + method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/SketchesReadOnlyException.html b/docs/7.0.X/org/apache/datasketches/common/SketchesReadOnlyException.html new file mode 100644 index 000000000..4ed479c5e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/SketchesReadOnlyException.html @@ -0,0 +1,184 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SketchesReadOnlyException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: SketchesReadOnlyException"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SketchesReadOnlyException.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class SketchesReadOnlyException" class="title">Class SketchesReadOnlyException</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a> +<div class="inheritance"><a href="SketchesException.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.SketchesException</a> +<div class="inheritance">org.apache.datasketches.common.SketchesReadOnlyException</div> +</div> +</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SketchesReadOnlyException</span> +<span class="extends-implements">extends <a href="SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></span></div> +<div class="block">Write operation attempted on a read-only class.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../serialized-form.html#org.apache.datasketches.common.SketchesReadOnlyException">Serialized Form</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SketchesReadOnlyException</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new runtime exception with the message: + "Write operation attempted on a read-only class."</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesReadOnlyException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>SketchesReadOnlyException</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SketchesReadOnlyException</span>()</div> +<div class="block">Constructs a new runtime exception with the message: + "Write operation attempted on a read-only class." + + <p>The cause is not initialized, and may subsequently be initialized by a call to + Throwable.initCause(java.lang.Throwable).</div> +</section> +</li> +<li> +<section class="detail" id="<init>(java.lang.String)"> +<h3>SketchesReadOnlyException</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SketchesReadOnlyException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span></div> +<div class="block">Constructs a new runtime exception with the specified detail message. The cause is not + initialized, and may subsequently be initialized by a call to + Throwable.initCause(java.lang.Throwable).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>message</code> - the detail message. The detail message is saved for later retrieval by the + Throwable.getMessage() method.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/SketchesStateException.html b/docs/7.0.X/org/apache/datasketches/common/SketchesStateException.html new file mode 100644 index 000000000..fb71aa5e3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/SketchesStateException.html @@ -0,0 +1,168 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SketchesStateException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: SketchesStateException"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SketchesStateException.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class SketchesStateException" class="title">Class SketchesStateException</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a> +<div class="inheritance"><a href="SketchesException.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.SketchesException</a> +<div class="inheritance">org.apache.datasketches.common.SketchesStateException</div> +</div> +</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SketchesStateException</span> +<span class="extends-implements">extends <a href="SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></span></div> +<div class="block">Illegal State Exception class for the library</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../serialized-form.html#org.apache.datasketches.common.SketchesStateException">Serialized Form</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">SketchesStateException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new runtime exception with the specified detail message.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(java.lang.String)"> +<h3>SketchesStateException</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SketchesStateException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span></div> +<div class="block">Constructs a new runtime exception with the specified detail message. The cause is not + initialized, and may subsequently be initialized by a call to + Throwable.initCause(java.lang.Throwable).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>message</code> - the detail message. The detail message is saved for later retrieval by the + Throwable.getMessage() method.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/SuppressFBWarnings.html b/docs/7.0.X/org/apache/datasketches/common/SuppressFBWarnings.html new file mode 100644 index 000000000..eb7782cee --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/SuppressFBWarnings.html @@ -0,0 +1,158 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SuppressFBWarnings (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, annotation type: SuppressFBWarnings"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SuppressFBWarnings.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Field | </li> +<li><a href="#annotation-interface-optional-element-summary">Optional</a> | </li> +<li>Required</li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation-interface-element-detail">Element</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Annotation Interface SuppressFBWarnings" class="title">Annotation Interface SuppressFBWarnings</h1> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#CLASS" title="class or interface in java.lang.annotation" class="external-link">CLASS</a>) +</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">SuppressFBWarnings</span></div> +<div class="block">Used to suppress SpotBug warnings.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY =========== --> +<li> +<section class="member-summary" id="annotation-interface-optional-element-summary"> +<h2>Optional Element Summary</h2> +<div class="caption"><span>Optional Elements</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Optional Element</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#justification()" class="member-name-link">justification</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Optional explanation for the suppression.</div> +</div> +<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> +<div class="col-second odd-row-color"><code><a href="#value()" class="member-name-link">value</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A list of comma-separated, quoted SpotBugs warnings that are to be suppressed in the associated + annotated element.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details" id="annotation-interface-element-detail"> +<ul class="details-list"> +<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== --> +<li> +<section class="member-details"> +<h2>Element Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="value()"> +<h3>value</h3> +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">value</span></div> +<div class="block">A list of comma-separated, quoted SpotBugs warnings that are to be suppressed in the associated + annotated element. The value can be a bug category, kind or pattern.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>list of relevant bug descriptors</dd> +</dl> +<dl class="notes"> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="justification()"> +<h3>justification</h3> +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">justification</span></div> +<div class="block">Optional explanation for the suppression.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>explanation</dd> +</dl> +<dl class="notes"> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/Util.html b/docs/7.0.X/org/apache/datasketches/common/Util.html new file mode 100644 index 000000000..0d1fffaa0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/Util.html @@ -0,0 +1,1290 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Util (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common, class: Util"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Util.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.common</a></div> +<h1 title="Class Util" class="title">Class Util</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.common.Util</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Util</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Common utility functions.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final double</code></div> +<div class="col-second even-row-color"><code><a href="#INVERSE_GOLDEN" class="member-name-link">INVERSE_GOLDEN</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The inverse golden ratio as a fraction.</div> +</div> +<div class="col-first odd-row-color"><code>static final long</code></div> +<div class="col-second odd-row-color"><code><a href="#INVERSE_GOLDEN_U64" class="member-name-link">INVERSE_GOLDEN_U64</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The inverse golden ratio as an unsigned long.</div> +</div> +<div class="col-first even-row-color"><code>static final double</code></div> +<div class="col-second even-row-color"><code><a href="#LOG2" class="member-name-link">LOG2</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The natural logarithm of 2.0.</div> +</div> +<div class="col-first odd-row-color"><code>static final double</code></div> +<div class="col-second odd-row-color"><code><a href="#LONG_MAX_VALUE_AS_DOUBLE" class="member-name-link">LONG_MAX_VALUE_AS_DOUBLE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Long.MAX_VALUE as a double.</div> +</div> +<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#LS" class="member-name-link">LS</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The java line separator character as a String.</div> +</div> +<div class="col-first odd-row-color"><code>static final char</code></div> +<div class="col-second odd-row-color"><code><a href="#TAB" class="member-name-link">TAB</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The tab character</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#bitAt(long,int)" class="member-name-link">bitAt</a><wbr>(long number, + int bitPos)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a one if the bit at bitPos is a one, otherwise zero.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#bytesToInt(byte%5B%5D)" class="member-name-link">bytesToInt</a><wbr>(byte[] arr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an int extracted from a Little-Endian byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#bytesToLong(byte%5B%5D)" class="member-name-link">bytesToLong</a><wbr>(byte[] arr)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a long extracted from a Little-Endian byte array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#bytesToString(byte%5B%5D,boolean,boolean,java.lang.String)" class="member-name-link">bytesToString</a><wbr>(byte[] arr, + boolean signed, + boolean littleEndian, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sep)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a string view of a byte array</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ceilingPowerBaseOfDouble(double,double)" class="member-name-link">ceilingPowerBaseOfDouble</a><wbr>(double base, + double n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the ceiling of a given <i>n</i> given a <i>base</i>, where the ceiling is an integral power of the base.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ceilingPowerOf2(int)" class="member-name-link">ceilingPowerOf2</a><wbr>(int n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the int ceiling power of 2 within the range [1, 2^30].</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ceilingPowerOf2(long)" class="member-name-link">ceilingPowerOf2</a><wbr>(long n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the long ceiling power of 2 within the range [1, 2^62].</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#characterPad(java.lang.String,int,char,boolean)" class="member-name-link">characterPad</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s, + int fieldLength, + char padChar, + boolean postpend)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Prepend or postpend the given string with the given character to fill the given field length.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkBounds(long,long,long)" class="member-name-link">checkBounds</a><wbr>(long reqOff, + long reqLen, + long allocSize)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Check the requested offset and length against the allocated size.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkIfMultipleOf8AndGT0(long,java.lang.String)" class="member-name-link">checkIfMultipleOf8AndGT0</a><wbr>(long v, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks if parameter v is a multiple of 8 and greater than zero.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkIfPowerOf2(long,java.lang.String)" class="member-name-link">checkIfPowerOf2</a><wbr>(long n, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks the given long argument if it is a positive integer power of 2.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkProbability(double,java.lang.String)" class="member-name-link">checkProbability</a><wbr>(double p, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks the given parameter to make sure it is positive and between 0.0 inclusive and 1.0 + inclusive.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#exactLog2OfInt(int)" class="member-name-link">exactLog2OfInt</a><wbr>(int powerOf2)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the log2 of the given int value if it is an exact power of 2 and greater than zero.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#exactLog2OfInt(int,java.lang.String)" class="member-name-link">exactLog2OfInt</a><wbr>(int powerOf2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the log2 of the given int value if it is an exact power of 2 and greater than zero.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#exactLog2OfLong(long)" class="member-name-link">exactLog2OfLong</a><wbr>(long powerOf2)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the log2 of the given long value if it is an exact power of 2 and greater than zero.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#exactLog2OfLong(long,java.lang.String)" class="member-name-link">exactLog2OfLong</a><wbr>(long powerOf2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the log2 of the given long value if it is an exact power of 2 and greater than zero.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#floorPowerBaseOfDouble(double,double)" class="member-name-link">floorPowerBaseOfDouble</a><wbr>(double base, + double n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the floor of a given <i>n</i> given <i>base</i>, where the floor is an integral power of the base.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#floorPowerOf2(int)" class="member-name-link">floorPowerOf2</a><wbr>(int n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the floor power of 2 given <i>n</i> is in the range [1, 2^31-1].</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#floorPowerOf2(long)" class="member-name-link">floorPowerOf2</a><wbr>(long n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the floor power of 2 given <i>n</i> is in the range [1, 2^63-1].</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#intToBytes(int,byte%5B%5D)" class="member-name-link">intToBytes</a><wbr>(int v, + byte[] arr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a Little-Endian byte array extracted from the given int.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#invPow2(int)" class="member-name-link">invPow2</a><wbr>(int e)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the inverse integer power of 2: 1/(2^e) = 2^(-e).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isEven(long)" class="member-name-link">isEven</a><wbr>(long n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns true if given n is even.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isLessThanUnsigned(long,long)" class="member-name-link">isLessThanUnsigned</a><wbr>(long n1, + long n2)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Unsigned compare with longs.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isMultipleOf8AndGT0(long)" class="member-name-link">isMultipleOf8AndGT0</a><wbr>(long v)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns true if v is a multiple of 8 and greater than zero</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isOdd(long)" class="member-name-link">isOdd</a><wbr>(long n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns true if given n is odd.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isPowerOf2(long)" class="member-name-link">isPowerOf2</a><wbr>(long n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns true if given long argument is exactly a positive power of 2.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#le(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">le</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Is item1 Less-Than-Or-Equal-To item2</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#log2(double)" class="member-name-link">log2</a><wbr>(double value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The log<sub>2</sub>(value)</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logBaseOfX(double,double)" class="member-name-link">logBaseOfX</a><wbr>(double base, + double x)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the log<sub>base</sub>(x).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#longToBytes(long,byte%5B%5D)" class="member-name-link">longToBytes</a><wbr>(long v, + byte[] arr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a Little-Endian byte array extracted from the given long.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#longToFixedLengthString(long,int)" class="member-name-link">longToFixedLengthString</a><wbr>(long number, + int length)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Converts the given number to a string prepended with spaces, if necessary, to + match the given length.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#longToHexBytes(long)" class="member-name-link">longToHexBytes</a><wbr>(long v)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a string of spaced hex bytes in Big-Endian order.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lt(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">lt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Is item1 Less-Than item2</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#maxT(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">maxT</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Finds the maximum of two generic items</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#milliSecToString(long)" class="member-name-link">milliSecToString</a><wbr>(long mS)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the given time in milliseconds formatted as Hours:Min:Sec.mSec</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#minT(java.lang.Object,java.lang.Object,java.util.Comparator)" class="member-name-link">minT</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Finds the minimum of two generic items</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nanoSecToString(long)" class="member-name-link">nanoSecToString</a><wbr>(long nS)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the given time in nanoseconds formatted as Sec.mSec_uSec_nSec</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#numberOfLeadingOnes(long)" class="member-name-link">numberOfLeadingOnes</a><wbr>(long v)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the number of one bits preceding the highest-order ("leftmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#numberOfTrailingOnes(long)" class="member-name-link">numberOfTrailingOnes</a><wbr>(long v)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the number of one bits following the lowest-order ("rightmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#numDigits(long)" class="member-name-link">numDigits</a><wbr>(long n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the number of decimal digits of the number n</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#powerSeriesNextDouble(int,double,boolean,double)" class="member-name-link">powerSeriesNextDouble</a><wbr>(int ppb, + double curPoint, + boolean roundToLong, + double logBase)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the next larger double in the power series + <i>point = logBase<sup>( i / ppb )</sup></i> given the current point in the series.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#pwr2SeriesNext(int,long)" class="member-name-link">pwr2SeriesNext</a><wbr>(int ppo, + long curPoint)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the next larger integer point in the power series + <i>point = 2<sup>( i / ppo )</sup></i> given the current point in the series.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#pwr2SeriesPrev(int,int)" class="member-name-link">pwr2SeriesPrev</a><wbr>(int ppo, + int curPoint)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the previous, smaller integer point in the power series + <i>point = 2<sup>( i / ppo )</sup></i> given the current point in the series.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#zeroPad(java.lang.String,int)" class="member-name-link">zeroPad</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s, + int fieldLength)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Prepend the given string with zeros.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="LS"> +<h3>LS</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">LS</span></div> +<div class="block">The java line separator character as a String.</div> +</section> +</li> +<li> +<section class="detail" id="TAB"> +<h3>TAB</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">char</span> <span class="element-name">TAB</span></div> +<div class="block">The tab character</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.common.Util.TAB">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="LOG2"> +<h3>LOG2</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">LOG2</span></div> +<div class="block">The natural logarithm of 2.0.</div> +</section> +</li> +<li> +<section class="detail" id="INVERSE_GOLDEN_U64"> +<h3>INVERSE_GOLDEN_U64</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name">INVERSE_GOLDEN_U64</span></div> +<div class="block">The inverse golden ratio as an unsigned long.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.common.Util.INVERSE_GOLDEN_U64">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="INVERSE_GOLDEN"> +<h3>INVERSE_GOLDEN</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">INVERSE_GOLDEN</span></div> +<div class="block">The inverse golden ratio as a fraction. + This has more precision than using the formula: (Math.sqrt(5.0) - 1.0) / 2.0.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.common.Util.INVERSE_GOLDEN">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="LONG_MAX_VALUE_AS_DOUBLE"> +<h3>LONG_MAX_VALUE_AS_DOUBLE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">LONG_MAX_VALUE_AS_DOUBLE</span></div> +<div class="block">Long.MAX_VALUE as a double.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.common.Util.LONG_MAX_VALUE_AS_DOUBLE">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="bytesToInt(byte[])"> +<h3>bytesToInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">bytesToInt</span><wbr><span class="parameters">(byte[] arr)</span></div> +<div class="block">Returns an int extracted from a Little-Endian byte array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>an int extracted from a Little-Endian byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="bytesToLong(byte[])"> +<h3>bytesToLong</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">bytesToLong</span><wbr><span class="parameters">(byte[] arr)</span></div> +<div class="block">Returns a long extracted from a Little-Endian byte array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a long extracted from a Little-Endian byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intToBytes(int,byte[])"> +<h3>intToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">intToBytes</span><wbr><span class="parameters">(int v, + byte[] arr)</span></div> +<div class="block">Returns a Little-Endian byte array extracted from the given int.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>v</code> - the given int</dd> +<dd><code>arr</code> - a given array of 4 bytes that will be returned with the data</dd> +<dt>Returns:</dt> +<dd>a Little-Endian byte array extracted from the given int.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="longToBytes(long,byte[])"> +<h3>longToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">longToBytes</span><wbr><span class="parameters">(long v, + byte[] arr)</span></div> +<div class="block">Returns a Little-Endian byte array extracted from the given long.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>v</code> - the given long</dd> +<dd><code>arr</code> - a given array of 8 bytes that will be returned with the data</dd> +<dt>Returns:</dt> +<dd>a Little-Endian byte array extracted from the given long.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="longToHexBytes(long)"> +<h3>longToHexBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">longToHexBytes</span><wbr><span class="parameters">(long v)</span></div> +<div class="block">Returns a string of spaced hex bytes in Big-Endian order.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>v</code> - the given long</dd> +<dt>Returns:</dt> +<dd>string of spaced hex bytes in Big-Endian order.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="bytesToString(byte[],boolean,boolean,java.lang.String)"> +<h3>bytesToString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">bytesToString</span><wbr><span class="parameters">(byte[] arr, + boolean signed, + boolean littleEndian, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sep)</span></div> +<div class="block">Returns a string view of a byte array</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given byte array</dd> +<dd><code>signed</code> - set true if you want the byte values signed.</dd> +<dd><code>littleEndian</code> - set true if you want Little-Endian order</dd> +<dd><code>sep</code> - the separator string between bytes</dd> +<dt>Returns:</dt> +<dd>a string view of a byte array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="nanoSecToString(long)"> +<h3>nanoSecToString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">nanoSecToString</span><wbr><span class="parameters">(long nS)</span></div> +<div class="block">Returns the given time in nanoseconds formatted as Sec.mSec_uSec_nSec</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nS</code> - the given nanoseconds</dd> +<dt>Returns:</dt> +<dd>the given time in nanoseconds formatted as Sec.mSec_uSec_nSec</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="milliSecToString(long)"> +<h3>milliSecToString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">milliSecToString</span><wbr><span class="parameters">(long mS)</span></div> +<div class="block">Returns the given time in milliseconds formatted as Hours:Min:Sec.mSec</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mS</code> - the given milliseconds</dd> +<dt>Returns:</dt> +<dd>the given time in milliseconds formatted as Hours:Min:Sec.mSec</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="zeroPad(java.lang.String,int)"> +<h3>zeroPad</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">zeroPad</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s, + int fieldLength)</span></div> +<div class="block">Prepend the given string with zeros. If the given string is equal or greater than the given + field length, it will be returned without modification.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>s</code> - the given string</dd> +<dd><code>fieldLength</code> - desired total field length including the given string</dd> +<dt>Returns:</dt> +<dd>the given string prepended with zeros.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="characterPad(java.lang.String,int,char,boolean)"> +<h3>characterPad</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">characterPad</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s, + int fieldLength, + char padChar, + boolean postpend)</span></div> +<div class="block">Prepend or postpend the given string with the given character to fill the given field length. + If the given string is equal to or greater than the given field length, it will be returned + without modification.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>s</code> - the given string</dd> +<dd><code>fieldLength</code> - the desired field length</dd> +<dd><code>padChar</code> - the desired pad character</dd> +<dd><code>postpend</code> - if true append the pacCharacters to the end of the string.</dd> +<dt>Returns:</dt> +<dd>prepended or postpended given string with the given character to fill the given field length.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkIfMultipleOf8AndGT0(long,java.lang.String)"> +<h3>checkIfMultipleOf8AndGT0</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkIfMultipleOf8AndGT0</span><wbr><span class="parameters">(long v, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</span></div> +<div class="block">Checks if parameter v is a multiple of 8 and greater than zero.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>v</code> - The parameter to check</dd> +<dd><code>argName</code> - This name will be part of the error message if the check fails.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isMultipleOf8AndGT0(long)"> +<h3>isMultipleOf8AndGT0</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isMultipleOf8AndGT0</span><wbr><span class="parameters">(long v)</span></div> +<div class="block">Returns true if v is a multiple of 8 and greater than zero</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>v</code> - The parameter to check</dd> +<dt>Returns:</dt> +<dd>true if v is a multiple of 8 and greater than zero</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isPowerOf2(long)"> +<h3>isPowerOf2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isPowerOf2</span><wbr><span class="parameters">(long n)</span></div> +<div class="block">Returns true if given long argument is exactly a positive power of 2.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - The input argument.</dd> +<dt>Returns:</dt> +<dd>true if argument is exactly a positive power of 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkIfPowerOf2(long,java.lang.String)"> +<h3>checkIfPowerOf2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkIfPowerOf2</span><wbr><span class="parameters">(long n, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</span></div> +<div class="block">Checks the given long argument if it is a positive integer power of 2. + If not, it throws an exception with the user supplied local argument name, if not null.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - The input long argument must be a positive integer power of 2.</dd> +<dd><code>argName</code> - Used in the thrown exception. It may be null.</dd> +<dt>Throws:</dt> +<dd><code><a href="SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></code> - if not a positive integer power of 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="ceilingPowerOf2(int)"> +<h3>ceilingPowerOf2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">ceilingPowerOf2</span><wbr><span class="parameters">(int n)</span></div> +<div class="block">Computes the int ceiling power of 2 within the range [1, 2^30]. This is the smallest positive power + of 2 that is equal to or greater than the given n and a positive integer. + + <p>For: + <ul> + <li>n ≤ 1: returns 1</li> + <li>2^30 ≤ n ≤ 2^31 -1 : returns 2^30</li> + <li>n == an exact power of 2 : returns n</li> + <li>otherwise returns the smallest power of 2 ≥ n and equal to a positive integer</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - The input int argument.</dd> +<dt>Returns:</dt> +<dd>the ceiling power of 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="ceilingPowerOf2(long)"> +<h3>ceilingPowerOf2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">ceilingPowerOf2</span><wbr><span class="parameters">(long n)</span></div> +<div class="block">Computes the long ceiling power of 2 within the range [1, 2^62]. This is the smallest positive power + of 2 that is equal to or greater than the given n and a positive long. + + <p>For: + <ul> + <li>n ≤ 1: returns 1</li> + <li>2^62 ≤ n ≤ 2^63 -1 : returns 2^62</li> + <li>n == an exact power of 2 : returns n</li> + <li>otherwise returns the smallest power of 2 ≥ n and equal to a positive long</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - The input long argument.</dd> +<dt>Returns:</dt> +<dd>the ceiling power of 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="floorPowerOf2(int)"> +<h3>floorPowerOf2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">floorPowerOf2</span><wbr><span class="parameters">(int n)</span></div> +<div class="block">Computes the floor power of 2 given <i>n</i> is in the range [1, 2^31-1]. + This is the largest positive power of 2 that equal to or less than the given n and equal + to a positive integer. + + <p>For: + <ul> + <li>n ≤ 1: returns 1</li> + <li>2^30 ≤ n ≤ 2^31 -1 : returns 2^30</li> + <li>n == a power of 2 : returns n</li> + <li>otherwise returns the largest power of 2 less than n and equal to a mathematical + integer.</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - The given int argument.</dd> +<dt>Returns:</dt> +<dd>the floor power of 2 as an int.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="floorPowerOf2(long)"> +<h3>floorPowerOf2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">floorPowerOf2</span><wbr><span class="parameters">(long n)</span></div> +<div class="block">Computes the floor power of 2 given <i>n</i> is in the range [1, 2^63-1]. + This is the largest positive power of 2 that is equal to or less than the given <i>n</i> and + equal to a positive integer. + + <p>For: + <ul> + <li>n ≤ 1: returns 1</li> + <li>2^62 ≤ n ≤ 2^63 -1 : returns 2^62</li> + <li>n == a power of 2 : returns n</li> + <li>otherwise returns the largest power of 2 less than n and equal to a mathematical + integer.</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - The given long argument.</dd> +<dt>Returns:</dt> +<dd>the floor power of 2 as a long</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="invPow2(int)"> +<h3>invPow2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">invPow2</span><wbr><span class="parameters">(int e)</span></div> +<div class="block">Computes the inverse integer power of 2: 1/(2^e) = 2^(-e).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>e</code> - a positive value between 0 and 1023 inclusive</dd> +<dt>Returns:</dt> +<dd>the inverse integer power of 2: 1/(2^e) = 2^(-e)</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="pwr2SeriesNext(int,long)"> +<h3>pwr2SeriesNext</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">pwr2SeriesNext</span><wbr><span class="parameters">(int ppo, + long curPoint)</span></div> +<div class="block">Computes the next larger integer point in the power series + <i>point = 2<sup>( i / ppo )</sup></i> given the current point in the series. + For illustration, this can be used in a loop as follows: + + <pre><code> + int maxP = 1024; + int minP = 1; + int ppo = 2; + + for (int p = minP; p <= maxP; p = pwr2LawNext(ppo, p)) { + System.out.print(p + " "); + } + //generates the following series: + //1 2 3 4 6 8 11 16 23 32 45 64 91 128 181 256 362 512 724 1024 + </code></pre></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ppo</code> - Points-Per-Octave, or the number of points per integer powers of 2 in the series.</dd> +<dd><code>curPoint</code> - the current point of the series. Must be ≥ 1.</dd> +<dt>Returns:</dt> +<dd>the next point in the power series.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="pwr2SeriesPrev(int,int)"> +<h3>pwr2SeriesPrev</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">pwr2SeriesPrev</span><wbr><span class="parameters">(int ppo, + int curPoint)</span></div> +<div class="block">Computes the previous, smaller integer point in the power series + <i>point = 2<sup>( i / ppo )</sup></i> given the current point in the series. + For illustration, this can be used in a loop as follows: + + <pre><code> + int maxP = 1024; + int minP = 1; + int ppo = 2; + + for (int p = maxP; p >= minP; p = pwr2LawPrev(ppo, p)) { + System.out.print(p + " "); + } + //generates the following series: + //1024 724 512 362 256 181 128 91 64 45 32 23 16 11 8 6 4 3 2 1 + </code></pre></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ppo</code> - Points-Per-Octave, or the number of points per integer powers of 2 in the series.</dd> +<dd><code>curPoint</code> - the current point of the series. Must be ≥ 1.</dd> +<dt>Returns:</dt> +<dd>the previous, smaller point in the power series. + A returned value of zero terminates the series.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="powerSeriesNextDouble(int,double,boolean,double)"> +<h3>powerSeriesNextDouble</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">powerSeriesNextDouble</span><wbr><span class="parameters">(int ppb, + double curPoint, + boolean roundToLong, + double logBase)</span></div> +<div class="block">Computes the next larger double in the power series + <i>point = logBase<sup>( i / ppb )</sup></i> given the current point in the series. + For illustration, this can be used in a loop as follows: + + <pre><code> + double maxP = 1024.0; + double minP = 1.0; + int ppb = 2; + double logBase = 2.0; + + for (double p = minP; p <= maxP; p = powerSeriesNextDouble(ppb, p, true, logBase)) { + System.out.print(p + " "); + } + //generates the following series: + //1 2 3 4 6 8 11 16 23 32 45 64 91 128 181 256 362 512 724 1024 + </code></pre></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ppb</code> - Points-Per-Base, or the number of points per integer powers of base in the series.</dd> +<dd><code>curPoint</code> - the current point of the series. Must be ≥ 1.0.</dd> +<dd><code>roundToLong</code> - if true the output will be rounded to the nearest long.</dd> +<dd><code>logBase</code> - the desired base of the logarithms</dd> +<dt>Returns:</dt> +<dd>the next point in the power series.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="ceilingPowerBaseOfDouble(double,double)"> +<h3>ceilingPowerBaseOfDouble</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">ceilingPowerBaseOfDouble</span><wbr><span class="parameters">(double base, + double n)</span></div> +<div class="block">Returns the ceiling of a given <i>n</i> given a <i>base</i>, where the ceiling is an integral power of the base. + This is the smallest positive power of <i>base</i> that is equal to or greater than the given <i>n</i> + and equal to a mathematical integer. + The result of this function is consistent with <a href="#ceilingPowerOf2(long)"><code>ceilingPowerOf2(int)</code></a> for values + less than one. I.e., if <i>n < 1,</i> the result is 1. + + <p>The formula is: <i>base<sup>ceiling(log<sub>base</sub>(x))</sup></i></p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>base</code> - The number in the expression ⌈base<sup>n</sup>⌉.</dd> +<dd><code>n</code> - The input argument.</dd> +<dt>Returns:</dt> +<dd>the ceiling power of <i>base</i> as a double and equal to a mathematical integer.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="floorPowerBaseOfDouble(double,double)"> +<h3>floorPowerBaseOfDouble</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">floorPowerBaseOfDouble</span><wbr><span class="parameters">(double base, + double n)</span></div> +<div class="block">Computes the floor of a given <i>n</i> given <i>base</i>, where the floor is an integral power of the base. + This is the largest positive power of <i>base</i> that is equal to or less than the given <i>n</i> + and equal to a mathematical integer. + The result of this function is consistent with <a href="#floorPowerOf2(long)"><code>floorPowerOf2(int)</code></a> for values + less than one. I.e., if <i>n < 1,</i> the result is 1. + + <p>The formula is: <i>base<sup>floor(log<sub>base</sub>(x))</sup></i></p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>base</code> - The number in the expression ⌊base<sup>n</sup>⌋.</dd> +<dd><code>n</code> - The input argument.</dd> +<dt>Returns:</dt> +<dd>the floor power of 2 and equal to a mathematical integer.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="log2(double)"> +<h3>log2</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">log2</span><wbr><span class="parameters">(double value)</span></div> +<div class="block">The log<sub>2</sub>(value)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - the given value</dd> +<dt>Returns:</dt> +<dd>log<sub>2</sub>(value)</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="logBaseOfX(double,double)"> +<h3>logBaseOfX</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">logBaseOfX</span><wbr><span class="parameters">(double base, + double x)</span></div> +<div class="block">Returns the log<sub>base</sub>(x). Example, if base = 2.0: logB(2.0, x) = log(x) / log(2.0).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>base</code> - The number in the expression log(x) / log(base).</dd> +<dd><code>x</code> - the given value</dd> +<dt>Returns:</dt> +<dd>the log<sub>base</sub>(x)</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="numberOfTrailingOnes(long)"> +<h3>numberOfTrailingOnes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">numberOfTrailingOnes</span><wbr><span class="parameters">(long v)</span></div> +<div class="block">Returns the number of one bits following the lowest-order ("rightmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>v</code> - the value whose number of trailing ones is to be computed.</dd> +<dt>Returns:</dt> +<dd>the number of one bits following the lowest-order ("rightmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="numberOfLeadingOnes(long)"> +<h3>numberOfLeadingOnes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">numberOfLeadingOnes</span><wbr><span class="parameters">(long v)</span></div> +<div class="block">Returns the number of one bits preceding the highest-order ("leftmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>v</code> - the value whose number of leading ones is to be computed.</dd> +<dt>Returns:</dt> +<dd>the number of one bits preceding the lowest-order ("rightmost") zero-bit in the + two's complement binary representation of the specified long value, or 64 if the value is equal + to minus one.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="exactLog2OfInt(int,java.lang.String)"> +<h3>exactLog2OfInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">exactLog2OfInt</span><wbr><span class="parameters">(int powerOf2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</span></div> +<div class="block">Returns the log2 of the given int value if it is an exact power of 2 and greater than zero. + If not, it throws an exception with the user supplied local argument name.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>powerOf2</code> - must be a power of 2 and greater than zero.</dd> +<dd><code>argName</code> - the argument name used in the exception if thrown.</dd> +<dt>Returns:</dt> +<dd>the log2 of the given value if it is an exact power of 2 and greater than zero.</dd> +<dt>Throws:</dt> +<dd><code><a href="SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></code> - if not a power of 2 nor greater than zero.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="exactLog2OfLong(long,java.lang.String)"> +<h3>exactLog2OfLong</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">exactLog2OfLong</span><wbr><span class="parameters">(long powerOf2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</span></div> +<div class="block">Returns the log2 of the given long value if it is an exact power of 2 and greater than zero. + If not, it throws an exception with the user supplied local argument name.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>powerOf2</code> - must be a power of 2 and greater than zero.</dd> +<dd><code>argName</code> - the argument name used in the exception if thrown.</dd> +<dt>Returns:</dt> +<dd>the log2 of the given value if it is an exact power of 2 and greater than zero.</dd> +<dt>Throws:</dt> +<dd><code><a href="SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></code> - if not a power of 2 nor greater than zero.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="exactLog2OfInt(int)"> +<h3>exactLog2OfInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">exactLog2OfInt</span><wbr><span class="parameters">(int powerOf2)</span></div> +<div class="block">Returns the log2 of the given int value if it is an exact power of 2 and greater than zero. + If not, it throws an exception.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>powerOf2</code> - must be a power of 2 and greater than zero.</dd> +<dt>Returns:</dt> +<dd>the log2 of the given int value if it is an exact power of 2 and greater than zero.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="exactLog2OfLong(long)"> +<h3>exactLog2OfLong</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">exactLog2OfLong</span><wbr><span class="parameters">(long powerOf2)</span></div> +<div class="block">Returns the log2 of the given long value if it is an exact power of 2 and greater than zero. + If not, it throws an exception.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>powerOf2</code> - must be a power of 2 and greater than zero.</dd> +<dt>Returns:</dt> +<dd>the log2 of the given long value if it is an exact power of 2 and greater than zero.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkBounds(long,long,long)"> +<h3>checkBounds</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkBounds</span><wbr><span class="parameters">(long reqOff, + long reqLen, + long allocSize)</span></div> +<div class="block">Check the requested offset and length against the allocated size. + The invariants equation is: <code>0 <= reqOff <= reqLen <= reqOff + reqLen <= allocSize</code>. + If this equation is violated an <a href="SketchesArgumentException.html" title="class in org.apache.datasketches.common"><code>SketchesArgumentException</code></a> will be thrown.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>reqOff</code> - the requested offset</dd> +<dd><code>reqLen</code> - the requested length</dd> +<dd><code>allocSize</code> - the allocated size.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkProbability(double,java.lang.String)"> +<h3>checkProbability</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkProbability</span><wbr><span class="parameters">(double p, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> argName)</span></div> +<div class="block">Checks the given parameter to make sure it is positive and between 0.0 inclusive and 1.0 + inclusive.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>p</code> - <a href="../../../../resources/dictionary.html#p">See Sampling Probability, <i>p</i></a></dd> +<dd><code>argName</code> - Used in the thrown exception.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isLessThanUnsigned(long,long)"> +<h3>isLessThanUnsigned</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isLessThanUnsigned</span><wbr><span class="parameters">(long n1, + long n2)</span></div> +<div class="block">Unsigned compare with longs.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n1</code> - A long to be treated as if unsigned.</dd> +<dd><code>n2</code> - A long to be treated as if unsigned.</dd> +<dt>Returns:</dt> +<dd>true if n1 > n2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEven(long)"> +<h3>isEven</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isEven</span><wbr><span class="parameters">(long n)</span></div> +<div class="block">Returns true if given n is even.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - the given n</dd> +<dt>Returns:</dt> +<dd>true if given n is even.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isOdd(long)"> +<h3>isOdd</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isOdd</span><wbr><span class="parameters">(long n)</span></div> +<div class="block">Returns true if given n is odd.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - the given n</dd> +<dt>Returns:</dt> +<dd>true if given n is odd.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="bitAt(long,int)"> +<h3>bitAt</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">bitAt</span><wbr><span class="parameters">(long number, + int bitPos)</span></div> +<div class="block">Returns a one if the bit at bitPos is a one, otherwise zero.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>number</code> - the number to examine</dd> +<dd><code>bitPos</code> - the given zero-based bit position, where the least significant + bit is at position zero.</dd> +<dt>Returns:</dt> +<dd>a one if the bit at bitPos is a one, otherwise zero.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="numDigits(long)"> +<h3>numDigits</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">numDigits</span><wbr><span class="parameters">(long n)</span></div> +<div class="block">Computes the number of decimal digits of the number n</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - the given number</dd> +<dt>Returns:</dt> +<dd>the number of decimal digits of the number n</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="longToFixedLengthString(long,int)"> +<h3>longToFixedLengthString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">longToFixedLengthString</span><wbr><span class="parameters">(long number, + int length)</span></div> +<div class="block">Converts the given number to a string prepended with spaces, if necessary, to + match the given length. + + <p>For example, assume a sequence of integers from 1 to 1000. The largest value has + four decimal digits. Convert the entire sequence of strings to the form " 1" to "1000". + When these strings are sorted they will be in numerical sequence: " 1", " 2", ... "1000".</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>number</code> - the given number</dd> +<dd><code>length</code> - the desired string length.</dd> +<dt>Returns:</dt> +<dd>the given number to a string prepended with spaces</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="minT(java.lang.Object,java.lang.Object,java.util.Comparator)"> +<h3>minT</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">minT</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</span></div> +<div class="block">Finds the minimum of two generic items</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the type</dd> +<dt>Parameters:</dt> +<dd><code>item1</code> - item one</dd> +<dd><code>item2</code> - item two</dd> +<dd><code>c</code> - the given comparator</dd> +<dt>Returns:</dt> +<dd>the minimum value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="maxT(java.lang.Object,java.lang.Object,java.util.Comparator)"> +<h3>maxT</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">maxT</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</span></div> +<div class="block">Finds the maximum of two generic items</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the type</dd> +<dt>Parameters:</dt> +<dd><code>item1</code> - item one</dd> +<dd><code>item2</code> - item two</dd> +<dd><code>c</code> - the given comparator</dd> +<dt>Returns:</dt> +<dd>the maximum value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="lt(java.lang.Object,java.lang.Object,java.util.Comparator)"> +<h3>lt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type">boolean</span> <span class="element-name">lt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</span></div> +<div class="block">Is item1 Less-Than item2</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the type</dd> +<dt>Parameters:</dt> +<dd><code>item1</code> - item one</dd> +<dd><code>item2</code> - item two</dd> +<dd><code>c</code> - the given comparator</dd> +<dt>Returns:</dt> +<dd>true if item1 Less-Than item2</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="le(java.lang.Object,java.lang.Object,java.util.Comparator)"> +<h3>le</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type">boolean</span> <span class="element-name">le</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item1, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> item2, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> c)</span></div> +<div class="block">Is item1 Less-Than-Or-Equal-To item2</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the type</dd> +<dt>Parameters:</dt> +<dd><code>item1</code> - item one</dd> +<dd><code>item2</code> - item two</dd> +<dd><code>c</code> - the given comparator</dd> +<dt>Returns:</dt> +<dd>true if item1 Less-Than-Or-Equal-To item2</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfBooleansSerDe.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfBooleansSerDe.html new file mode 100644 index 000000000..bcc4132d9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfBooleansSerDe.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ArrayOfBooleansSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ArrayOfBooleansSerDe"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ArrayOfBooleansSerDe" class="title">Uses of Class<br>org.apache.datasketches.common.ArrayOfBooleansSerDe</h1> +</div> +No usage of org.apache.datasketches.common.ArrayOfBooleansSerDe</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfDoublesSerDe.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfDoublesSerDe.html new file mode 100644 index 000000000..7eb6c761b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfDoublesSerDe.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ArrayOfDoublesSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ArrayOfDoublesSerDe"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ArrayOfDoublesSerDe" class="title">Uses of Class<br>org.apache.datasketches.common.ArrayOfDoublesSerDe</h1> +</div> +No usage of org.apache.datasketches.common.ArrayOfDoublesSerDe</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfItemsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfItemsSerDe.html new file mode 100644 index 000000000..57e4d59ea --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfItemsSerDe.html @@ -0,0 +1,376 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ArrayOfItemsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ArrayOfItemsSerDe"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ArrayOfItemsSerDe" class="title">Uses of Class<br>org.apache.datasketches.common.ArrayOfItemsSerDe</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.common">org.apache.datasketches.common</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.common"> +<h2>Uses of <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a> in <a href="../package-summary.html">org.apache.datasketches.common</a></h2> +<div class="caption"><span>Subclasses of <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a> in <a href="../package-summary.html">org.apache.datasketches.common</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ArrayOfBooleansSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Methods of serializing and deserializing arrays of Boolean as a bit array.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../ArrayOfDoublesSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Methods of serializing and deserializing arrays of Double.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ArrayOfLongsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Methods of serializing and deserializing arrays of Long.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../ArrayOfNumbersSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Methods of serializing and deserializing arrays of the object version of primitive types of + Number.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ArrayOfStringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../ArrayOfUtf16StringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<h2>Uses of <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a> in <a href="../../frequencies/package-summary.html">org.apache.datasketches.frequencies</a></h2> +<div class="caption"><span>Methods in <a href="../../frequencies/package-summary.html">org.apache.datasketches.frequencies</a> with parameters of type <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../frequencies/ItemsSketch.html#getInstance(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../frequencies/ItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../frequencies/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a byte array representation of this sketch</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> with parameters of type <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#newHeapInstance(int,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance</a><wbr>(int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#newHeapInstance(java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#wrap(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a thin wrapper on the heap around a Memory (or WritableMemory) already initialized with a + validated sketch image of a type T consistent with the given comparator and serDe.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> with parameters of type <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapifies the given srcMem, which must be a Memory image of a ItemsSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../../quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../../quantiles/ItemsUnion.html#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given srcMem into a Union object.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">putMemory</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Puts the current sketch into the given Memory if there is sufficient space.</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#toByteArray(boolean,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(boolean ordered, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Serialize this sketch to a byte array form.</div> +</div> +<div class="col-first even-row-color"><code>byte[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Serialize this sketch to a byte array form.</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../../quantiles/ItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Serialize this union to a byte array.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../../quantiles/ItemsUnion.html#union(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">union</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a> in <a href="../../sampling/package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../../sampling/package-summary.html">org.apache.datasketches.sampling</a> with parameters of type <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">EbppsItemsSketch.</span><code><a href="../../sampling/EbppsItemsSketch.html#getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getSerializedSizeBytes</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the size of a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color"><code>int</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">EbppsItemsSketch.</span><code><a href="../../sampling/EbppsItemsSketch.html#getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">getSerializedSizeBytes</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the length of a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">EbppsItemsSketch.</span><code><a href="../../sampling/EbppsItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../../sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../../sampling/ReservoirItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../../sampling/ReservoirItemsUnion.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../../sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../../sampling/VarOptItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../../sampling/VarOptItemsUnion.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">EbppsItemsSketch.</span><code><a href="../../sampling/EbppsItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color"><code>byte[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">EbppsItemsSketch.</span><code><a href="../../sampling/EbppsItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../../sampling/ReservoirItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color"><code>byte[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../../sampling/ReservoirItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../../sampling/ReservoirItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../sampling/ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a byte array representation of this union</div> +</div> +<div class="col-first even-row-color"><code>byte[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../../sampling/ReservoirItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../sampling/ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a byte array representation of this union.</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../../sampling/VarOptItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color"><code>byte[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../../sampling/VarOptItemsSketch.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="../../sampling/VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color"><code>byte[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../../sampling/VarOptItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../sampling/VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a byte array representation of this union</div> +</div> +<div class="col-first even-row-color"><code>byte[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../../sampling/VarOptItemsUnion.html#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../sampling/VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a byte array representation of this union.</div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../../sampling/ReservoirItemsUnion.html#update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">update</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../sampling/ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Union the given Memory image of the sketch.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../../sampling/VarOptItemsUnion.html#update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">update</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="../../sampling/VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Union the given Memory image of the sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfLongsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfLongsSerDe.html new file mode 100644 index 000000000..059d4a160 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfLongsSerDe.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ArrayOfLongsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ArrayOfLongsSerDe"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ArrayOfLongsSerDe" class="title">Uses of Class<br>org.apache.datasketches.common.ArrayOfLongsSerDe</h1> +</div> +No usage of org.apache.datasketches.common.ArrayOfLongsSerDe</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfNumbersSerDe.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfNumbersSerDe.html new file mode 100644 index 000000000..0ca9c0c0a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfNumbersSerDe.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ArrayOfNumbersSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ArrayOfNumbersSerDe"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ArrayOfNumbersSerDe" class="title">Uses of Class<br>org.apache.datasketches.common.ArrayOfNumbersSerDe</h1> +</div> +No usage of org.apache.datasketches.common.ArrayOfNumbersSerDe</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfStringsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfStringsSerDe.html new file mode 100644 index 000000000..2f38b20e6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfStringsSerDe.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ArrayOfStringsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ArrayOfStringsSerDe"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ArrayOfStringsSerDe" class="title">Uses of Class<br>org.apache.datasketches.common.ArrayOfStringsSerDe</h1> +</div> +No usage of org.apache.datasketches.common.ArrayOfStringsSerDe</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfUtf16StringsSerDe.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfUtf16StringsSerDe.html new file mode 100644 index 000000000..0aef036a7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ArrayOfUtf16StringsSerDe.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ArrayOfUtf16StringsSerDe (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ArrayOfUtf16StringsSerDe"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ArrayOfUtf16StringsSerDe" class="title">Uses of Class<br>org.apache.datasketches.common.ArrayOfUtf16StringsSerDe</h1> +</div> +No usage of org.apache.datasketches.common.ArrayOfUtf16StringsSerDe</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/BoundsOnBinomialProportions.html b/docs/7.0.X/org/apache/datasketches/common/class-use/BoundsOnBinomialProportions.html new file mode 100644 index 000000000..ab4881c1d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/BoundsOnBinomialProportions.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.BoundsOnBinomialProportions (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: BoundsOnBinomialProportions"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.BoundsOnBinomialProportions" class="title">Uses of Class<br>org.apache.datasketches.common.BoundsOnBinomialProportions</h1> +</div> +No usage of org.apache.datasketches.common.BoundsOnBinomialProportions</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/BoundsOnRatiosInSampledSets.html b/docs/7.0.X/org/apache/datasketches/common/class-use/BoundsOnRatiosInSampledSets.html new file mode 100644 index 000000000..c8a78f01c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/BoundsOnRatiosInSampledSets.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.BoundsOnRatiosInSampledSets (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: BoundsOnRatiosInSampledSets"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.BoundsOnRatiosInSampledSets" class="title">Uses of Class<br>org.apache.datasketches.common.BoundsOnRatiosInSampledSets</h1> +</div> +No usage of org.apache.datasketches.common.BoundsOnRatiosInSampledSets</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ByteArrayUtil.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ByteArrayUtil.html new file mode 100644 index 000000000..ae64f1626 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ByteArrayUtil.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.ByteArrayUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: ByteArrayUtil"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ByteArrayUtil.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.ByteArrayUtil" class="title">Uses of Class<br>org.apache.datasketches.common.ByteArrayUtil</h1> +</div> +No usage of org.apache.datasketches.common.ByteArrayUtil</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/Family.html b/docs/7.0.X/org/apache/datasketches/common/class-use/Family.html new file mode 100644 index 000000000..4614f02ea --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/Family.html @@ -0,0 +1,203 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.common.Family (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, enum: Family"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Family.html" title="enum class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.common.Family" class="title">Uses of Enum Class<br>org.apache.datasketches.common.Family</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.common">org.apache.datasketches.common</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.cpc">org.apache.datasketches.cpc</a></div> +<div class="col-last odd-row-color"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.common"> +<h2>Uses of <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a> in <a href="../package-summary.html">org.apache.datasketches.common</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.common</a> that return <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Family.</span><code><a href="../Family.html#idToFamily(int)" class="member-name-link">idToFamily</a><wbr>(int id)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the Family given the ID</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Family.</span><code><a href="../Family.html#stringToFamily(java.lang.String)" class="member-name-link">stringToFamily</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> famName)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the Family given the family name</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Family.</span><code><a href="../Family.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Family.</span><code><a href="../Family.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.cpc"> +<h2>Uses of <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a> in <a href="../../cpc/package-summary.html">org.apache.datasketches.cpc</a></h2> +<div class="caption"><span>Methods in <a href="../../cpc/package-summary.html">org.apache.datasketches.cpc</a> that return <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CpcSketch.</span><code><a href="../../cpc/CpcSketch.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">CpcUnion.</span><code><a href="../../cpc/CpcUnion.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CpcWrapper.</span><code><a href="../../cpc/CpcWrapper.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a> in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a> that return <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../../theta/AnotB.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../../theta/CompactSketch.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../../theta/Intersection.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>abstract <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../../theta/SetOperation.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the Family of this SetOperation</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketch.</span><code><a href="../../theta/Sketch.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the Family that this sketch belongs to</div> +</div> +<div class="col-first odd-row-color"><code><a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../../theta/Union.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../../theta/UpdateSketchBuilder.html#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the Family</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a> with parameters of type <a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../../theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../../theta/SetOperationBuilder.html#build(org.apache.datasketches.common.Family)" class="member-name-link">build</a><wbr>(<a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../../theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../../theta/SetOperationBuilder.html#build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(<a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a> family, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family + and the given destination memory.</div> +</div> +<div class="col-first even-row-color"><code><a href="../../theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../../theta/UpdateSketchBuilder.html#setFamily(org.apache.datasketches.common.Family)" class="member-name-link">setFamily</a><wbr>(<a href="../Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</code></div> +<div class="col-last even-row-color"> +<div class="block">Set the Family.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/MemoryStatus.html b/docs/7.0.X/org/apache/datasketches/common/class-use/MemoryStatus.html new file mode 100644 index 000000000..2d53aa338 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/MemoryStatus.html @@ -0,0 +1,122 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.common.MemoryStatus (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, interface: MemoryStatus"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../MemoryStatus.html" title="interface in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.common.MemoryStatus" class="title">Uses of Interface<br>org.apache.datasketches.common.MemoryStatus</h1> +</div> +<div class="caption"><span>Packages that use <a href="../MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a> in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Classes in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a> that implement <a href="../MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../theta/AnotB.html" class="type-name-link" title="class in org.apache.datasketches.theta">AnotB</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../theta/CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The parent class of all the CompactSketches.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../theta/Intersection.html" class="type-name-link" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The API for intersection operations</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../theta/SetOperation.html" class="type-name-link" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The parent API for all Set Operations</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../theta/Sketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The top-level class for all theta sketches.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../theta/Union.html" class="type-name-link" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Compute the union of two or more theta sketches.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../theta/UpdateSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/ResizeFactor.html b/docs/7.0.X/org/apache/datasketches/common/class-use/ResizeFactor.html new file mode 100644 index 000000000..b64ccbc9a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/ResizeFactor.html @@ -0,0 +1,259 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.common.ResizeFactor (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, enum: ResizeFactor"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.common.ResizeFactor" class="title">Uses of Enum Class<br>org.apache.datasketches.common.ResizeFactor</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.common">org.apache.datasketches.common</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.common"> +<h2>Uses of <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> in <a href="../package-summary.html">org.apache.datasketches.common</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.common</a> that return <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ResizeFactor.</span><code><a href="../ResizeFactor.html#getRF(int)" class="member-name-link">getRF</a><wbr>(int lg)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the Resize Factor given the Log-base 2 of the Resize Factor</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ResizeFactor.</span><code><a href="../ResizeFactor.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ResizeFactor.</span><code><a href="../ResizeFactor.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> in <a href="../../sampling/package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../../sampling/package-summary.html">org.apache.datasketches.sampling</a> with parameters of type <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../../sampling/ReservoirItemsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct a mergeable sampling sketch with up to k samples using a specified resize factor.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../../sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirLongsSketch.</span><code><a href="../../sampling/ReservoirLongsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../../sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../../sampling/VarOptItemsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct a varopt sampling sketch with up to k samples using the specified resize factor.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a> that return <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../../theta/SetOperationBuilder.html#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the Resize Factor</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../../theta/UpdateSketch.html#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the configured ResizeFactor</div> +</div> +<div class="col-first even-row-color"><code><a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../../theta/UpdateSketchBuilder.html#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the Resize Factor</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a> with parameters of type <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../../theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../../theta/SetOperationBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last even-row-color"> +<div class="block">Sets the cache Resize Factor</div> +</div> +<div class="col-first odd-row-color"><code><a href="../../theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../../theta/UpdateSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the cache Resize Factor.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../../tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="../../tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="../../tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdatableSketchBuilder.</span><code><a href="../../tuple/UpdatableSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to set the resize factor.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> in <a href="../../tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../../tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>abstract <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketch.</span><code><a href="../../tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the configured resize factor</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> with parameters of type <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../../tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../../tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to set the resize factor.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> in <a href="../../tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Constructors in <a href="../../tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a> with parameters of type <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../../tuple/strings/ArrayOfStringsSketch.html#%3Cinit%3E(int,org.apache.datasketches.common.ResizeFactor,float)" class="member-name-link">ArrayOfStringsSketch</a><wbr>(int lgK, + <a href="../ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf, + float p)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs new sketch with given ResizeFactor, <i>p</i> and <i>lgK</i>.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesArgumentException.html b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesArgumentException.html new file mode 100644 index 000000000..f703a6182 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesArgumentException.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.SketchesArgumentException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: SketchesArgumentException"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SketchesArgumentException.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.SketchesArgumentException" class="title">Uses of Class<br>org.apache.datasketches.common.SketchesArgumentException</h1> +</div> +No usage of org.apache.datasketches.common.SketchesArgumentException</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesException.html b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesException.html new file mode 100644 index 000000000..90b586a5b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesException.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.SketchesException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: SketchesException"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SketchesException.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.SketchesException" class="title">Uses of Class<br>org.apache.datasketches.common.SketchesException</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.common">org.apache.datasketches.common</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.common"> +<h2>Uses of <a href="../SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a> in <a href="../package-summary.html">org.apache.datasketches.common</a></h2> +<div class="caption"><span>Subclasses of <a href="../SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a> in <a href="../package-summary.html">org.apache.datasketches.common</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../SketchesArgumentException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesArgumentException</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Illegal Arguments Exception class for the library</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../SketchesReadOnlyException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Write operation attempted on a read-only class.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../SketchesStateException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesStateException</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Illegal State Exception class for the library</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesReadOnlyException.html b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesReadOnlyException.html new file mode 100644 index 000000000..8e2d0a556 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesReadOnlyException.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.SketchesReadOnlyException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: SketchesReadOnlyException"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.SketchesReadOnlyException" class="title">Uses of Class<br>org.apache.datasketches.common.SketchesReadOnlyException</h1> +</div> +No usage of org.apache.datasketches.common.SketchesReadOnlyException</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesStateException.html b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesStateException.html new file mode 100644 index 000000000..acdc07da4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/SketchesStateException.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.SketchesStateException (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: SketchesStateException"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SketchesStateException.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.SketchesStateException" class="title">Uses of Class<br>org.apache.datasketches.common.SketchesStateException</h1> +</div> +No usage of org.apache.datasketches.common.SketchesStateException</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/SuppressFBWarnings.html b/docs/7.0.X/org/apache/datasketches/common/class-use/SuppressFBWarnings.html new file mode 100644 index 000000000..bb9e20eaa --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/SuppressFBWarnings.html @@ -0,0 +1,285 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Annotation Interface org.apache.datasketches.common.SuppressFBWarnings (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, annotation type: SuppressFBWarnings"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Annotation Interface org.apache.datasketches.common.SuppressFBWarnings" class="title">Uses of Annotation Interface<br>org.apache.datasketches.common.SuppressFBWarnings</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.common">org.apache.datasketches.common</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.cpc">org.apache.datasketches.cpc</a></div> +<div class="col-last odd-row-color"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.common"> +<h2>Uses of <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> in <a href="../package-summary.html">org.apache.datasketches.common</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.common</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Family.</span><code><a href="../Family.html#getID()" class="member-name-link">getID</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the byte ID for this family</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.cpc"> +<h2>Uses of <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> in <a href="../../cpc/package-summary.html">org.apache.datasketches.cpc</a></h2> +<div class="caption"><span>Constructors in <a href="../../cpc/package-summary.html">org.apache.datasketches.cpc</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../../cpc/CompressionCharacterization.html#%3Cinit%3E(int,int,int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">CompressionCharacterization</a><wbr>(int lgMinK, + int lgMaxK, + int lgMinT, + int lgMaxT, + int lgMulK, + int uPPO, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</code></div> +<div class="col-last even-row-color"> +<div class="block">Only used in test.</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../../cpc/CpcWrapper.html#%3Cinit%3E(org.apache.datasketches.memory.Memory)" class="member-name-link">CpcWrapper</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct a read-only view of the given Memory that contains a CpcSketch</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../../cpc/MergingValidation.html#%3Cinit%3E(int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">MergingValidation</a><wbr>(int lgMinK, + int lgMaxK, + int lgMulK, + int uPPO, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../../cpc/QuickMergingValidation.html#%3Cinit%3E(int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">QuickMergingValidation</a><wbr>(int lgMinK, + int lgMaxK, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> ps, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../../cpc/StreamingValidation.html#%3Cinit%3E(int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">StreamingValidation</a><wbr>(int lgMinK, + int lgMaxK, + int trials, + int ppoN, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<h2>Uses of <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> in <a href="../../frequencies/package-summary.html">org.apache.datasketches.frequencies</a></h2> +<div class="caption"><span>Classes in <a href="../../frequencies/package-summary.html">org.apache.datasketches.frequencies</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../frequencies/LongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional + associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of + such items.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../../quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../../quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../../quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../../theta/package-summary.html">org.apache.datasketches.theta</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../../theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../../theta/UpdateSketchBuilder.html#buildShared(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildShared</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder and the given destination WritableMemory.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../../theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../../theta/UpdateSketchBuilder.html#buildSharedFromSketch(org.apache.datasketches.theta.UpdateSketch,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildSharedFromSketch</a><wbr>(<a href="../../theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> sketch, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder, the data from the given sketch, and the given destination + WritableMemory.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Classes in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../tuple/AnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple">AnotB</a><S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../../tuple/AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../../tuple/AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> in <a href="../../tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../../tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> with annotations of type <a href="../SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesAnotBImpl.</span><code><a href="../../tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">update</a><wbr>(<a href="../../tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skA, + <a href="../../tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skB)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/class-use/Util.html b/docs/7.0.X/org/apache/datasketches/common/class-use/Util.html new file mode 100644 index 000000000..fd69c2c56 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/class-use/Util.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.common.Util (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common, class: Util"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Util.html" title="class in org.apache.datasketches.common">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.common.Util" class="title">Uses of Class<br>org.apache.datasketches.common.Util</h1> +</div> +No usage of org.apache.datasketches.common.Util</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/package-summary.html b/docs/7.0.X/org/apache/datasketches/common/package-summary.html new file mode 100644 index 000000000..829a2f37f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/package-summary.html @@ -0,0 +1,193 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.common (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.common"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.common" class="title">Package org.apache.datasketches.common</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.common</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button><button id="class-summary-tab7" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab7', 2)" class="table-tab">Annotation Interfaces</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Methods of serializing and deserializing arrays of Boolean as a bit array.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Methods of serializing and deserializing arrays of Double.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Base class for serializing and deserializing custom types.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfLongsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Methods of serializing and deserializing arrays of Long.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Methods of serializing and deserializing arrays of the object version of primitive types of + Number.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfStringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Methods of serializing and deserializing arrays of String.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BoundsOnBinomialProportions.html" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Confidence intervals for binomial proportions.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>|B| / |A|</i>, where: + + <i>|A|</i> is the unknown size of a set <i>A</i> of unique identifiers. + <i>|B|</i> is the unknown size of a subset <i>B</i> of <i>A</i>. + <i>a</i> = <i>|S<sub>A</sub>|</i> is the observed size of a sample of <i>A</i> + that was obtained by Bernoulli sampling with a known inclusion probability <i>f</i>. + <i>b</i> = <i>|S<sub>A</sub> ∩ B|</i> is the observed size of a subset + of <i>S<sub>A</sub></i>. + </div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ByteArrayUtil.html" title="class in org.apache.datasketches.common">ByteArrayUtil</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Useful methods for byte arrays.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">Defines the various families of sketch and set operation classes.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">Methods for inquiring the status of a backing Memory object.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="SketchesArgumentException.html" title="class in org.apache.datasketches.common">SketchesArgumentException</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab5"> +<div class="block">Illegal Arguments Exception class for the library</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab5"><a href="SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a></div> +<div class="col-last even-row-color class-summary class-summary-tab5"> +<div class="block">Exception class for the library</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab5"> +<div class="block">Write operation attempted on a read-only class.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab5"><a href="SketchesStateException.html" title="class in org.apache.datasketches.common">SketchesStateException</a></div> +<div class="col-last even-row-color class-summary class-summary-tab5"> +<div class="block">Illegal State Exception class for the library</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="SuppressFBWarnings.html" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab7"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Util.html" title="class in org.apache.datasketches.common">Util</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Common utility functions.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/package-tree.html b/docs/7.0.X/org/apache/datasketches/common/package-tree.html new file mode 100644 index 000000000..44678166a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/package-tree.html @@ -0,0 +1,135 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.common Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.common"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.common</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="ArrayOfItemsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="ArrayOfBooleansSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="ArrayOfDoublesSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="ArrayOfLongsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="ArrayOfNumbersSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="ArrayOfStringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="ArrayOfUtf16StringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.common.<a href="BoundsOnBinomialProportions.html" class="type-name-link" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></li> +<li class="circle">org.apache.datasketches.common.<a href="BoundsOnRatiosInSampledSets.html" class="type-name-link" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></li> +<li class="circle">org.apache.datasketches.common.<a href="ByteArrayUtil.html" class="type-name-link" title="class in org.apache.datasketches.common">ByteArrayUtil</a></li> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" class="type-name-link external-link" title="class or interface in java.lang">Throwable</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" class="type-name-link external-link" title="class or interface in java.lang">Exception</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" class="type-name-link external-link" title="class or interface in java.lang">RuntimeException</a> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="SketchesException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesException</a> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="SketchesArgumentException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesArgumentException</a></li> +<li class="circle">org.apache.datasketches.common.<a href="SketchesReadOnlyException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></li> +<li class="circle">org.apache.datasketches.common.<a href="SketchesStateException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesStateException</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.common.<a href="Util.html" class="type-name-link" title="class in org.apache.datasketches.common">Util</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="MemoryStatus.html" class="type-name-link" title="interface in org.apache.datasketches.common">MemoryStatus</a></li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Annotation Interface Hierarchy">Annotation Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="SuppressFBWarnings.html" class="type-name-link" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> (implements java.lang.annotation.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Annotation.html" title="class or interface in java.lang.annotation" class="external-link">Annotation</a>)</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.common.<a href="Family.html" class="type-name-link" title="enum class in org.apache.datasketches.common">Family</a></li> +<li class="circle">org.apache.datasketches.common.<a href="ResizeFactor.html" class="type-name-link" title="enum class in org.apache.datasketches.common">ResizeFactor</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/common/package-use.html b/docs/7.0.X/org/apache/datasketches/common/package-use.html new file mode 100644 index 000000000..7c08171ea --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/common/package-use.html @@ -0,0 +1,306 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.common (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.common"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.common" class="title">Uses of Package<br>org.apache.datasketches.common</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.common</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.common">org.apache.datasketches.common</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.cpc">org.apache.datasketches.cpc</a></div> +<div class="col-last odd-row-color"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.common"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="package-summary.html">org.apache.datasketches.common</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.common">ArrayOfItemsSerDe</a></div> +<div class="col-last even-row-color"> +<div class="block">Base class for serializing and deserializing custom types.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Family.html#org.apache.datasketches.common">Family</a></div> +<div class="col-last odd-row-color"> +<div class="block">Defines the various families of sketch and set operation classes.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ResizeFactor.html#org.apache.datasketches.common">ResizeFactor</a></div> +<div class="col-last even-row-color"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SketchesException.html#org.apache.datasketches.common">SketchesException</a></div> +<div class="col-last odd-row-color"> +<div class="block">Exception class for the library</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.common">SuppressFBWarnings</a></div> +<div class="col-last even-row-color"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.cpc"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../cpc/package-summary.html">org.apache.datasketches.cpc</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/Family.html#org.apache.datasketches.cpc">Family</a></div> +<div class="col-last even-row-color"> +<div class="block">Defines the various families of sketch and set operation classes.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.cpc">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../frequencies/package-summary.html">org.apache.datasketches.frequencies</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.frequencies">ArrayOfItemsSerDe</a></div> +<div class="col-last even-row-color"> +<div class="block">Base class for serializing and deserializing custom types.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.frequencies">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../kll/package-summary.html">org.apache.datasketches.kll</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.kll">ArrayOfItemsSerDe</a></div> +<div class="col-last even-row-color"> +<div class="block">Base class for serializing and deserializing custom types.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.kll">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.quantiles">ArrayOfItemsSerDe</a></div> +<div class="col-last even-row-color"> +<div class="block">Base class for serializing and deserializing custom types.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../sampling/package-summary.html">org.apache.datasketches.sampling</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.sampling">ArrayOfItemsSerDe</a></div> +<div class="col-last even-row-color"> +<div class="block">Base class for serializing and deserializing custom types.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ResizeFactor.html#org.apache.datasketches.sampling">ResizeFactor</a></div> +<div class="col-last odd-row-color"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../theta/package-summary.html">org.apache.datasketches.theta</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/Family.html#org.apache.datasketches.theta">Family</a></div> +<div class="col-last even-row-color"> +<div class="block">Defines the various families of sketch and set operation classes.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/MemoryStatus.html#org.apache.datasketches.theta">MemoryStatus</a></div> +<div class="col-last odd-row-color"> +<div class="block">Methods for inquiring the status of a backing Memory object.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ResizeFactor.html#org.apache.datasketches.theta">ResizeFactor</a></div> +<div class="col-last even-row-color"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.theta">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../tuple/package-summary.html">org.apache.datasketches.tuple</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ResizeFactor.html#org.apache.datasketches.tuple">ResizeFactor</a></div> +<div class="col-last even-row-color"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.tuple">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ResizeFactor.html#org.apache.datasketches.tuple.arrayofdoubles">ResizeFactor</a></div> +<div class="col-last even-row-color"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.tuple.arrayofdoubles">SuppressFBWarnings</a></div> +<div class="col-last odd-row-color"> +<div class="block">Used to suppress SpotBug warnings.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ResizeFactor.html#org.apache.datasketches.tuple.strings">ResizeFactor</a></div> +<div class="col-last even-row-color"> +<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that + affects how fast the internal cache grows, when more space is required.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/CompressionCharacterization.html b/docs/7.0.X/org/apache/datasketches/cpc/CompressionCharacterization.html new file mode 100644 index 000000000..0e529a4a4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/CompressionCharacterization.html @@ -0,0 +1,205 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CompressionCharacterization (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: CompressionCharacterization"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CompressionCharacterization.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class CompressionCharacterization" class="title">Class CompressionCharacterization</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.CompressionCharacterization</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CompressionCharacterization</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing. To be + accessible for both, this code is part of the main hierarchy. It is not used during normal + production runtime.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int,int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">CompressionCharacterization</a><wbr>(int lgMinK, + int lgMaxK, + int lgMinT, + int lgMaxT, + int lgMulK, + int uPPO, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</code></div> +<div class="col-last even-row-color"> +<div class="block">Only used in test.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Only used in test</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int,int,int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)"> +<h3>CompressionCharacterization</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CompressionCharacterization</span><wbr><span class="parameters">(int lgMinK, + int lgMaxK, + int lgMinT, + int lgMaxT, + int lgMulK, + int uPPO, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</span></div> +<div class="block">Only used in test.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgMinK</code> - min lgK</dd> +<dd><code>lgMaxK</code> - max lgK</dd> +<dd><code>lgMinT</code> - min lgTrials</dd> +<dd><code>lgMaxT</code> - max lgTrials</dd> +<dd><code>lgMulK</code> - lg multiple</dd> +<dd><code>uPPO</code> - unique axis Points Per Octave</dd> +<dd><code>incLgK</code> - increment lgK</dd> +<dd><code>pS</code> - PrintStream</dd> +<dd><code>pW</code> - PrintWriter</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="start()"> +<h3>start</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span>()</div> +<div class="block">Only used in test</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/CpcSketch.html b/docs/7.0.X/org/apache/datasketches/cpc/CpcSketch.html new file mode 100644 index 000000000..ccb73631d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/CpcSketch.html @@ -0,0 +1,735 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CpcSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: CpcSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CpcSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class CpcSketch" class="title">Class CpcSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.CpcSketch</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CpcSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This is a unique-counting sketch that implements the + <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in + his paper + <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly + Optimal Cardinality Estimation Algorithm</a>. + + <p>This sketch is extremely space-efficient when serialized. In an apples-to-apples empirical + comparison against compressed HyperLogLog sketches, this new algorithm simultaneously wins on + the two dimensions of the space/accuracy tradeoff and produces sketches that are + smaller than the entropy of HLL, so no possible implementation of compressed HLL can match its + space efficiency for a given accuracy. As described in the paper this sketch implements a newly + developed ICON estimator algorithm that survives unioning operations, another + well-known estimator, the + <a href="https://arxiv.org/abs/1306.3284">Historical Inverse Probability (HIP)</a> estimator + does not. + The update speed performance of this sketch is quite fast and is comparable to the speed of HLL. + The unioning (merging) capability of this sketch also allows for merging of sketches with + different configurations of K. + + <p>For additional security this sketch can be configured with a user-specified hash seed.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final int</code></div> +<div class="col-second even-row-color"><code><a href="#DEFAULT_LG_K" class="member-name-link">DEFAULT_LG_K</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The default Log_base2 of K</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CpcSketch</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor with default log_base2 of k</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">CpcSketch</a><wbr>(int lgK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructor with log_base2 of k.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,long)" class="member-name-link">CpcSketch</a><wbr>(int lgK, + long seed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor with log_base2 of k and seed.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the best estimate of the cardinality of the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return the parameter LgK.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int)" class="member-name-link">getLowerBound</a><wbr>(int kappa)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxSerializedBytes(int)" class="member-name-link">getMaxSerializedBytes</a><wbr>(int lgK)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The actual size of a compressed CPC sketch has a small random variance, but the following + empirically measured size should be large enough for at least 99.9 percent of sketches.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int)" class="member-name-link">getUpperBound</a><wbr>(int kappa)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(byte%5B%5D)" class="member-name-link">heapify</a><wbr>(byte[] byteArray)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the given byte array as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(byte%5B%5D,long)" class="member-name-link">heapify</a><wbr>(byte[] byteArray, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the given byte array as a CpcSketch on the Java heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the given Memory as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the given Memory as a CpcSketch on the Java heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return true if this sketch is empty</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to empty but retains the original LgK and Seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return this sketch as a compressed byte array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return a human-readable string summary of this sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean)" class="member-name-link">toString</a><wbr>(boolean detail)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return a human-readable string summary of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D,boolean)" class="member-name-link">toString</a><wbr>(byte[] byteArr, + boolean detail)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a CpcSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory,boolean)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem, + boolean detail)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a CpcSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given byte array as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(char%5B%5D)" class="member-name-link">update</a><wbr>(char[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given char array as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given double (or float) datum as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(int%5B%5D)" class="member-name-link">update</a><wbr>(int[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given integer array as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given long as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D)" class="member-name-link">update</a><wbr>(long[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given long array as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given String as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.nio.ByteBuffer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given ByteBuffer as a potential unique item + If the ByteBuffer is null or empty no update attempt is made and the method returns</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate()" class="member-name-link">validate</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Convience function that this Sketch is valid.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DEFAULT_LG_K"> +<h3>DEFAULT_LG_K</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_LG_K</span></div> +<div class="block">The default Log_base2 of K</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.cpc.CpcSketch.DEFAULT_LG_K">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>CpcSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcSketch</span>()</div> +<div class="block">Constructor with default log_base2 of k</div> +</section> +</li> +<li> +<section class="detail" id="<init>(int)"> +<h3>CpcSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcSketch</span><wbr><span class="parameters">(int lgK)</span></div> +<div class="block">Constructor with log_base2 of k.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - the given log_base2 of k</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,long)"> +<h3>CpcSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcSketch</span><wbr><span class="parameters">(int lgK, + long seed)</span></div> +<div class="block">Constructor with log_base2 of k and seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - the given log_base2 of k</dd> +<dd><code>seed</code> - the given seed</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<div class="block">Returns the best estimate of the cardinality of the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the best estimate of the cardinality of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the DataSketches identifier for this CPC family of sketches.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Return the parameter LgK.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the parameter LgK.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int kappa)</span></div> +<div class="block">Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>kappa</code> - the given number of standard deviations from the mean: 1, 2 or 3.</dd> +<dt>Returns:</dt> +<dd>the best estimate of the lower bound of the confidence interval given <i>kappa</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxSerializedBytes(int)"> +<h3>getMaxSerializedBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxSerializedBytes</span><wbr><span class="parameters">(int lgK)</span></div> +<div class="block">The actual size of a compressed CPC sketch has a small random variance, but the following + empirically measured size should be large enough for at least 99.9 percent of sketches. + + <p>For small values of <i>n</i> the size can be much smaller.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - the given value of lgK.</dd> +<dt>Returns:</dt> +<dd>the estimated maximum compressed serialized size of a sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int kappa)</span></div> +<div class="block">Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>kappa</code> - the given number of standard deviations from the mean: 1, 2 or 3.</dd> +<dt>Returns:</dt> +<dd>the best estimate of the upper bound of the confidence interval given <i>kappa</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Return the given Memory as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>the given Memory as a CpcSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(byte[])"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(byte[] byteArray)</span></div> +<div class="block">Return the given byte array as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArray</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>the given byte array as a CpcSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long seed)</span></div> +<div class="block">Return the given Memory as a CpcSketch on the Java heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>seed</code> - the seed used to create the original sketch from which the Memory was derived.</dd> +<dt>Returns:</dt> +<dd>the given Memory as a CpcSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(byte[],long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(byte[] byteArray, + long seed)</span></div> +<div class="block">Return the given byte array as a CpcSketch on the Java heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArray</code> - the given byte array</dd> +<dd><code>seed</code> - the seed used to create the original sketch from which the byte array was derived.</dd> +<dt>Returns:</dt> +<dd>the given byte array as a CpcSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Return true if this sketch is empty</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is empty</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to empty but retains the original LgK and Seed.</div> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Return this sketch as a compressed byte array.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch as a compressed byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long datum)</span></div> +<div class="block">Present the given long as a potential unique item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given long datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double datum)</span></div> +<div class="block">Present the given double (or float) datum as a potential unique item. + The double will be converted to a long using Double.doubleToLongBits(datum), + which normalizes all NaN values to a single NaN representation. + Plus and minus zero will be normalized to plus zero. + The special floating-point values NaN and +/- Infinity are treated as distinct.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given double datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</span></div> +<div class="block">Present the given String as a potential unique item. + The string is converted to a byte array using UTF8 encoding. + If the string is null or empty no update attempt is made and the method returns. + + <p>Note: About 2X faster performance can be obtained by first converting the String to a + char[] and updating the sketch with that. This bypasses the complexity of the Java UTF_8 + encoding. This, of course, will not produce the same internal hash values as updating directly + with a String. So be consistent! Unioning two sketches, one fed with strings and the other + fed with char[] will be meaningless. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given String.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Present the given byte array as a potential unique item. + If the byte array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.nio.ByteBuffer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</span></div> +<div class="block">Present the given ByteBuffer as a potential unique item + If the ByteBuffer is null or empty no update attempt is made and the method returns</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given ByteBuffer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(char[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Present the given char array as a potential unique item. + If the char array is null or empty no update attempt is made and the method returns. + + <p>Note: this will not produce the same output hash values as the <a href="#update(java.lang.String)"><code>update(String)</code></a> + method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given char array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Present the given integer array as a potential unique item. + If the integer array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given int array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Present the given long array as a potential unique item. + If the long array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given long array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="validate()"> +<h3>validate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">validate</span>()</div> +<div class="block">Convience function that this Sketch is valid. This is a troubleshooting tool + for sketches that have been heapified from serialized images. + + <p>If you are starting with a serialized image as a byte array, first heapify + the byte array to a sketch, which performs a number of checks. Then use this + function as one additional check on the sketch.</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is validated.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Return a human-readable string summary of this sketch</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean detail)</span></div> +<div class="block">Return a human-readable string summary of this sketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>detail</code> - include data detail</dd> +<dt>Returns:</dt> +<dd>a human-readable string summary of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[],boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr, + boolean detail)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a CpcSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dd><code>detail</code> - if true, a dump of the compressed window and surprising value streams will be + included.</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a CpcSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + boolean detail)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a CpcSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>detail</code> - if true, a dump of the compressed window and surprising value streams will be + included.</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a CpcSketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/CpcUnion.html b/docs/7.0.X/org/apache/datasketches/cpc/CpcUnion.html new file mode 100644 index 000000000..f0c226a87 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/CpcUnion.html @@ -0,0 +1,261 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CpcUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: CpcUnion"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CpcUnion.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class CpcUnion" class="title">Class CpcUnion</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.CpcUnion</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CpcUnion</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The union (merge) operation for the CPC sketches.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CpcUnion</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct this unioning object with the default LgK and the default update seed.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">CpcUnion</a><wbr>(int lgK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct this unioning object with LgK and the default update seed.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,long)" class="member-name-link">CpcUnion</a><wbr>(int lgK, + long seed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct this unioning object with LgK and a given seed.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current value of Log_base2 of K.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the result of union operations as a CPC sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.cpc.CpcSketch)" class="member-name-link">update</a><wbr>(<a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a> sketch)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this union with a CpcSketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>CpcUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcUnion</span>()</div> +<div class="block">Construct this unioning object with the default LgK and the default update seed.</div> +</section> +</li> +<li> +<section class="detail" id="<init>(int)"> +<h3>CpcUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcUnion</span><wbr><span class="parameters">(int lgK)</span></div> +<div class="block">Construct this unioning object with LgK and the default update seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - The given log2 of K.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,long)"> +<h3>CpcUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcUnion</span><wbr><span class="parameters">(int lgK, + long seed)</span></div> +<div class="block">Construct this unioning object with LgK and a given seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - The given log2 of K.</dd> +<dd><code>seed</code> - The given seed.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(org.apache.datasketches.cpc.CpcSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a> sketch)</span></div> +<div class="block">Update this union with a CpcSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - the given CpcSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Returns the result of union operations as a CPC sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of union operations as a CPC sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Returns the current value of Log_base2 of K. Note that due to merging with source sketches that + may have a lower value of LgK, this value can be less than what the union object was configured + with.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current value of Log_base2 of K.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the DataSketches identifier for this CPC family of sketches.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/CpcWrapper.html b/docs/7.0.X/org/apache/datasketches/cpc/CpcWrapper.html new file mode 100644 index 000000000..933a81d32 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/CpcWrapper.html @@ -0,0 +1,270 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CpcWrapper (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: CpcWrapper"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CpcWrapper.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class CpcWrapper" class="title">Class CpcWrapper</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.CpcWrapper</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CpcWrapper</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This provides a read-only view of a serialized image of a CpcSketch, which can be + on-heap or off-heap represented as a Memory object, or on-heap represented as a byte array.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(byte%5B%5D)" class="member-name-link">CpcWrapper</a><wbr>(byte[] byteArray)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct a read-only view of the given byte array that contains a CpcSketch.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.memory.Memory)" class="member-name-link">CpcWrapper</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct a read-only view of the given Memory that contains a CpcSketch</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the best estimate of the cardinality of the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the configured Log_base2 of K of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int)" class="member-name-link">getLowerBound</a><wbr>(int kappa)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int)" class="member-name-link">getUpperBound</a><wbr>(int kappa)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.memory.Memory)"> +<h3>CpcWrapper</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcWrapper</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Construct a read-only view of the given Memory that contains a CpcSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(byte[])"> +<h3>CpcWrapper</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpcWrapper</span><wbr><span class="parameters">(byte[] byteArray)</span></div> +<div class="block">Construct a read-only view of the given byte array that contains a CpcSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArray</code> - the given byte array</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<div class="block">Returns the best estimate of the cardinality of the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the best estimate of the cardinality of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the DataSketches identifier for this CPC family of sketches.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Returns the configured Log_base2 of K of this sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the configured Log_base2 of K of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int kappa)</span></div> +<div class="block">Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>kappa</code> - the given number of standard deviations from the mean: 1, 2 or 3.</dd> +<dt>Returns:</dt> +<dd>the best estimate of the lower bound of the confidence interval given <i>kappa</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int kappa)</span></div> +<div class="block">Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>, + the number of standard deviations from the mean.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>kappa</code> - the given number of standard deviations from the mean: 1, 2 or 3.</dd> +<dt>Returns:</dt> +<dd>the best estimate of the upper bound of the confidence interval given <i>kappa</i>.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/MergingValidation.html b/docs/7.0.X/org/apache/datasketches/cpc/MergingValidation.html new file mode 100644 index 000000000..316438ef9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/MergingValidation.html @@ -0,0 +1,193 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>MergingValidation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: MergingValidation"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/MergingValidation.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class MergingValidation" class="title">Class MergingValidation</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.MergingValidation</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MergingValidation</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing. To be + accessible for both, this code is part of the main hierarchy. It is not used during normal + production runtime.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">MergingValidation</a><wbr>(int lgMinK, + int lgMaxK, + int lgMulK, + int uPPO, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int,int,int,int,int,java.io.PrintStream,java.io.PrintWriter)"> +<h3>MergingValidation</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">MergingValidation</span><wbr><span class="parameters">(int lgMinK, + int lgMaxK, + int lgMulK, + int uPPO, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgMinK</code> - lgMinK</dd> +<dd><code>lgMaxK</code> - lgMaxK</dd> +<dd><code>lgMulK</code> - lgMulK</dd> +<dd><code>uPPO</code> - uPPO</dd> +<dd><code>incLgK</code> - incLgK</dd> +<dd><code>pS</code> - pS</dd> +<dd><code>pW</code> - pW</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="start()"> +<h3>start</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span>()</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/QuickMergingValidation.html b/docs/7.0.X/org/apache/datasketches/cpc/QuickMergingValidation.html new file mode 100644 index 000000000..703509705 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/QuickMergingValidation.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuickMergingValidation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: QuickMergingValidation"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuickMergingValidation.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class QuickMergingValidation" class="title">Class QuickMergingValidation</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.QuickMergingValidation</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">QuickMergingValidation</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing. To be + accessible for both, this code is part of the main hierarchy. It is not used during normal + production runtime. + + <p>This test of merging is the equal K case and is less exhaustive than TestAlltest + but is more practical for large values of K.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">QuickMergingValidation</a><wbr>(int lgMinK, + int lgMaxK, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> ps, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int,int,int,java.io.PrintStream,java.io.PrintWriter)"> +<h3>QuickMergingValidation</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">QuickMergingValidation</span><wbr><span class="parameters">(int lgMinK, + int lgMaxK, + int incLgK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> ps, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgMinK</code> - lgMinK</dd> +<dd><code>lgMaxK</code> - lgMaxK</dd> +<dd><code>incLgK</code> - incLgK</dd> +<dd><code>ps</code> - ps</dd> +<dd><code>pw</code> - pw</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="start()"> +<h3>start</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span>()</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/StreamingValidation.html b/docs/7.0.X/org/apache/datasketches/cpc/StreamingValidation.html new file mode 100644 index 000000000..dbda6e8b2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/StreamingValidation.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>StreamingValidation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: StreamingValidation"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/StreamingValidation.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class StreamingValidation" class="title">Class StreamingValidation</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.StreamingValidation</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StreamingValidation</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing. To be + accessible for both, this code is part of the main hierarchy. It is not used during normal + production runtime.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int,int,int,java.io.PrintStream,java.io.PrintWriter)" class="member-name-link">StreamingValidation</a><wbr>(int lgMinK, + int lgMaxK, + int trials, + int ppoN, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int,int,int,int,java.io.PrintStream,java.io.PrintWriter)"> +<h3>StreamingValidation</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StreamingValidation</span><wbr><span class="parameters">(int lgMinK, + int lgMaxK, + int trials, + int ppoN, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a> pS, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pW)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgMinK</code> - lgMinK</dd> +<dd><code>lgMaxK</code> - lgMaxK</dd> +<dd><code>trials</code> - trials</dd> +<dd><code>ppoN</code> - ppoN</dd> +<dd><code>pS</code> - pS</dd> +<dd><code>pW</code> - pW</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="start()"> +<h3>start</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span>()</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/TestUtil.html b/docs/7.0.X/org/apache/datasketches/cpc/TestUtil.html new file mode 100644 index 000000000..1abf8a049 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/TestUtil.html @@ -0,0 +1,136 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>TestUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc, class: TestUtil"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/TestUtil.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.cpc</a></div> +<h1 title="Class TestUtil" class="title">Class TestUtil</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.cpc.TestUtil</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TestUtil</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TestUtil</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>TestUtil</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TestUtil</span>()</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/CompressionCharacterization.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CompressionCharacterization.html new file mode 100644 index 000000000..e4d0797e0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CompressionCharacterization.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.CompressionCharacterization (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: CompressionCharacterization"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../CompressionCharacterization.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.CompressionCharacterization" class="title">Uses of Class<br>org.apache.datasketches.cpc.CompressionCharacterization</h1> +</div> +No usage of org.apache.datasketches.cpc.CompressionCharacterization</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcSketch.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcSketch.html new file mode 100644 index 000000000..708d45513 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcSketch.html @@ -0,0 +1,124 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.CpcSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: CpcSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.CpcSketch" class="title">Uses of Class<br>org.apache.datasketches.cpc.CpcSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.cpc">org.apache.datasketches.cpc</a></div> +<div class="col-last even-row-color"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.cpc"> +<h2>Uses of <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a> in <a href="../package-summary.html">org.apache.datasketches.cpc</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.cpc</a> that return <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CpcUnion.</span><code><a href="../CpcUnion.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the result of union operations as a CPC sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">CpcSketch.</span><code><a href="../CpcSketch.html#heapify(byte%5B%5D)" class="member-name-link">heapify</a><wbr>(byte[] byteArray)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Return the given byte array as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CpcSketch.</span><code><a href="../CpcSketch.html#heapify(byte%5B%5D,long)" class="member-name-link">heapify</a><wbr>(byte[] byteArray, + long seed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Return the given byte array as a CpcSketch on the Java heap.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">CpcSketch.</span><code><a href="../CpcSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Return the given Memory as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CpcSketch.</span><code><a href="../CpcSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Return the given Memory as a CpcSketch on the Java heap.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.cpc</a> with parameters of type <a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">CpcUnion.</span><code><a href="../CpcUnion.html#update(org.apache.datasketches.cpc.CpcSketch)" class="member-name-link">update</a><wbr>(<a href="../CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Update this union with a CpcSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcUnion.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcUnion.html new file mode 100644 index 000000000..2100b54cf --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcUnion.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.CpcUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: CpcUnion"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../CpcUnion.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.CpcUnion" class="title">Uses of Class<br>org.apache.datasketches.cpc.CpcUnion</h1> +</div> +No usage of org.apache.datasketches.cpc.CpcUnion</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcWrapper.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcWrapper.html new file mode 100644 index 000000000..13c3b6bfa --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/CpcWrapper.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.CpcWrapper (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: CpcWrapper"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../CpcWrapper.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.CpcWrapper" class="title">Uses of Class<br>org.apache.datasketches.cpc.CpcWrapper</h1> +</div> +No usage of org.apache.datasketches.cpc.CpcWrapper</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/MergingValidation.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/MergingValidation.html new file mode 100644 index 000000000..df6f3aebc --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/MergingValidation.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.MergingValidation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: MergingValidation"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../MergingValidation.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.MergingValidation" class="title">Uses of Class<br>org.apache.datasketches.cpc.MergingValidation</h1> +</div> +No usage of org.apache.datasketches.cpc.MergingValidation</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/QuickMergingValidation.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/QuickMergingValidation.html new file mode 100644 index 000000000..d78657ee5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/QuickMergingValidation.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.QuickMergingValidation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: QuickMergingValidation"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuickMergingValidation.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.QuickMergingValidation" class="title">Uses of Class<br>org.apache.datasketches.cpc.QuickMergingValidation</h1> +</div> +No usage of org.apache.datasketches.cpc.QuickMergingValidation</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/StreamingValidation.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/StreamingValidation.html new file mode 100644 index 000000000..2bf073fa2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/StreamingValidation.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.StreamingValidation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: StreamingValidation"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../StreamingValidation.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.StreamingValidation" class="title">Uses of Class<br>org.apache.datasketches.cpc.StreamingValidation</h1> +</div> +No usage of org.apache.datasketches.cpc.StreamingValidation</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/class-use/TestUtil.html b/docs/7.0.X/org/apache/datasketches/cpc/class-use/TestUtil.html new file mode 100644 index 000000000..428b9f6ec --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/class-use/TestUtil.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.cpc.TestUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc, class: TestUtil"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../TestUtil.html" title="class in org.apache.datasketches.cpc">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.cpc.TestUtil" class="title">Uses of Class<br>org.apache.datasketches.cpc.TestUtil</h1> +</div> +No usage of org.apache.datasketches.cpc.TestUtil</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/package-summary.html b/docs/7.0.X/org/apache/datasketches/cpc/package-summary.html new file mode 100644 index 000000000..0b1f14fb3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/package-summary.html @@ -0,0 +1,140 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.cpc (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.cpc"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.cpc" class="title">Package org.apache.datasketches.cpc</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.cpc</span></div> +<section class="package-description" id="package-description"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CompressionCharacterization.html" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This is a unique-counting sketch that implements the + <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in + his paper + <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly + Optimal Cardinality Estimation Algorithm</a>.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The union (merge) operation for the CPC sketches.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This provides a read-only view of a serialized image of a CpcSketch, which can be + on-heap or off-heap represented as a Memory object, or on-heap represented as a byte array.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MergingValidation.html" title="class in org.apache.datasketches.cpc">MergingValidation</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="QuickMergingValidation.html" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="StreamingValidation.html" title="class in org.apache.datasketches.cpc">StreamingValidation</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This code is used both by unit tests, for short running tests, + and by the characterization repository for longer running, more exhaustive testing.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TestUtil.html" title="class in org.apache.datasketches.cpc">TestUtil</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> </div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/package-tree.html b/docs/7.0.X/org/apache/datasketches/cpc/package-tree.html new file mode 100644 index 000000000..6d5368d1c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/package-tree.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.cpc Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.cpc"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.cpc</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.cpc.<a href="CompressionCharacterization.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="CpcSketch.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcSketch</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="CpcUnion.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcUnion</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="CpcWrapper.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcWrapper</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="MergingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">MergingValidation</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="QuickMergingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="StreamingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">StreamingValidation</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="TestUtil.html" class="type-name-link" title="class in org.apache.datasketches.cpc">TestUtil</a></li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/cpc/package-use.html b/docs/7.0.X/org/apache/datasketches/cpc/package-use.html new file mode 100644 index 000000000..d6a72d5e7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/cpc/package-use.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.cpc (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.cpc"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.cpc" class="title">Uses of Package<br>org.apache.datasketches.cpc</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.cpc</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.cpc">org.apache.datasketches.cpc</a></div> +<div class="col-last even-row-color"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.cpc"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.cpc</a> used by <a href="package-summary.html">org.apache.datasketches.cpc</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/CpcSketch.html#org.apache.datasketches.cpc">CpcSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">This is a unique-counting sketch that implements the + <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in + his paper + <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly + Optimal Cardinality Estimation Algorithm</a>.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/FdtSketch.html b/docs/7.0.X/org/apache/datasketches/fdt/FdtSketch.html new file mode 100644 index 000000000..42cf0f55a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/FdtSketch.html @@ -0,0 +1,540 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>FdtSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.fdt, class: FdtSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/FdtSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.fdt</a></div> +<h1 title="Class FdtSketch" class="title">Class FdtSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S> +<div class="inheritance"><a href="../tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[],<wbr><a href="../tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>> +<div class="inheritance"><a href="../tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings.ArrayOfStringsSketch</a> +<div class="inheritance">org.apache.datasketches.fdt.FdtSketch</div> +</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">FdtSketch</span> +<span class="extends-implements">extends <a href="../tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></span></div> +<div class="block">A Frequent Distinct Tuples sketch. + + <p>Suppose our data is a stream of pairs {IP address, User ID} and we want to identify the + IP addresses that have the most distinct User IDs. Or conversely, we would like to identify + the User IDs that have the most distinct IP addresses. This is a common challenge in the + analysis of big data and the FDT sketch helps solve this problem using probabilistic techniques. + + <p>More generally, given a multiset of tuples with dimensions <i>{d1,d2, d3, ..., dN}</i>, + and a primary subset of dimensions <i>M < N</i>, our task is to identify the combinations of + <i>M</i> subset dimensions that have the most frequent number of distinct combinations of + the <i>N-M</i> non-primary dimensions. + + <p>Please refer to the web page + <a href="https://datasketches.apache.org/docs/Frequency/FrequentDistinctTuplesSketch.html"> + https://datasketches.apache.org/docs/Frequency/FrequentDistinctTuplesSketch.html</a> for a more + complete discussion about this sketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double,double)" class="member-name-link">FdtSketch</a><wbr>(double threshold, + double rse)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new instance of Frequent Distinct Tuples sketch with a size determined by the given + threshold and rse.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">FdtSketch</a><wbr>(int lgK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create new instance of Frequent Distinct Tuples sketch with the given + Log-base2 of required nominal entries.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch)" class="member-name-link">FdtSketch</a><wbr>(<a href="FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Copy Constructor</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentCapacity()" class="member-name-link">getCurrentCapacity</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get current capacity</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get log_base2 of Nominal Entries</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNominalEntries()" class="member-name-link">getNominalEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured nominal number of entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPostProcessor()" class="member-name-link">getPostProcessor</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPostProcessor(org.apache.datasketches.fdt.Group,char)" class="member-name-link">getPostProcessor</a><wbr>(<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured resize factor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult(int%5B%5D,int,int,char)" class="member-name-link">getResult</a><wbr>(int[] priKeyIndices, + int limit, + int numStdDev, + char sep)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an ordered List of Groups of the most frequent distinct population of subset tuples + represented by the count of entries of each group.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplingProbability()" class="member-name-link">getSamplingProbability</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured sampling probability</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../tuple/TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="../tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SketchIterator</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch an empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trim()" class="member-name-link">trim</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String%5B%5D)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] tuple)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update the sketch with the given string array tuple.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.strings.ArrayOfStringsSketch">Methods inherited from class org.apache.datasketches.tuple.strings.<a href="../tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></h3> +<code><a href="../tuple/strings/ArrayOfStringsSketch.html#update(java.lang.String%5B%5D,java.lang.String%5B%5D)">update</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.UpdatableSketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></h3> +<code><a href="../tuple/UpdatableSketch.html#update(byte%5B%5D,U)">update</a>, <a href="../tuple/UpdatableSketch.html#update(double,U)">update</a>, <a href="../tuple/UpdatableSketch.html#update(int%5B%5D,U)">update</a>, <a href="../tuple/UpdatableSketch.html#update(long%5B%5D,U)">update</a>, <a href="../tuple/UpdatableSketch.html#update(long,U)">update</a>, <a href="../tuple/UpdatableSketch.html#update(java.lang.String,U)">update</a>, <a href="../tuple/UpdatableSketch.html#update(java.nio.ByteBuffer,U)">update</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.Sketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> +<code><a href="../tuple/Sketch.html#getEstimate()">getEstimate</a>, <a href="../tuple/Sketch.html#getEstimate(int)">getEstimate</a>, <a href="../tuple/Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="../tuple/Sketch.html#getLowerBound(int,int)">getLowerBound</a>, <a href="../tuple/Sketch.html#getSummaryFactory()">getSummaryFactory</a>, <a href="../tuple/Sketch.html#getTheta()">getTheta</a>, <a href="../tuple/Sketch.html#getThetaLong()">getThetaLong</a>, <a href="../tuple/Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="../tuple/Sketch.html#getUpperBound(int,int)">getUpperBound</a>, <a href="../tuple/Sketch.html#isEmpty()">isEmpty</a>, <a href="../tuple/Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="../tuple/Sketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int)"> +<h3>FdtSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FdtSketch</span><wbr><span class="parameters">(int lgK)</span></div> +<div class="block">Create new instance of Frequent Distinct Tuples sketch with the given + Log-base2 of required nominal entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - Log-base2 of required nominal entries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(double,double)"> +<h3>FdtSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FdtSketch</span><wbr><span class="parameters">(double threshold, + double rse)</span></div> +<div class="block">Create a new instance of Frequent Distinct Tuples sketch with a size determined by the given + threshold and rse.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>threshold</code> - : the fraction, between zero and 1.0, of the total distinct stream length + that defines a "Frequent" (or heavy) item.</dd> +<dd><code>rse</code> - the maximum Relative Standard Error for the estimate of the distinct population of a + reported tuple (selected with a primary key) at the threshold.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.fdt.FdtSketch)"> +<h3>FdtSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FdtSketch</span><wbr><span class="parameters">(<a href="FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> sketch)</span></div> +<div class="block">Copy Constructor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - the sketch to copy</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></span> <span class="element-name">copy</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="../tuple/strings/ArrayOfStringsSketch.html#copy()">copy</a></code> in class <code><a href="../tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></code></dd> +<dt>Returns:</dt> +<dd>a deep copy of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] tuple)</span></div> +<div class="block">Update the sketch with the given string array tuple.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tuple</code> - the given string array tuple.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(int[],int,int,char)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a>></span> <span class="element-name">getResult</span><wbr><span class="parameters">(int[] priKeyIndices, + int limit, + int numStdDev, + char sep)</span></div> +<div class="block">Returns an ordered List of Groups of the most frequent distinct population of subset tuples + represented by the count of entries of each group.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>priKeyIndices</code> - these indices define the dimensions used for the Primary Keys.</dd> +<dd><code>limit</code> - the maximum number of groups to return. If this value is ≤ 0, all + groups will be returned.</dd> +<dd><code>numStdDev</code> - the number of standard deviations for the upper and lower error bounds, + this value is an integer and must be one of 1, 2, or 3. + <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dd><code>sep</code> - the separator character</dd> +<dt>Returns:</dt> +<dd>an ordered List of Groups of the most frequent distinct population of subset tuples + represented by the count of entries of each group.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPostProcessor()"> +<h3>getPostProcessor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></span> <span class="element-name">getPostProcessor</span>()</div> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results. + This assumes the default Group and the default separator character '|'.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the PostProcessor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPostProcessor(org.apache.datasketches.fdt.Group,char)"> +<h3>getPostProcessor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></span> <span class="element-name">getPostProcessor</span><wbr><span class="parameters">(<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</span></div> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>group</code> - the Group class to use during post processing.</dd> +<dd><code>sep</code> - the separator character.</dd> +<dt>Returns:</dt> +<dd>the PostProcessor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../tuple/Sketch.html#getRetainedEntries()">getRetainedEntries</a></code> in class <code><a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../tuple/Sketch.html#getCountLessThanThetaLong(long)">Sketch</a></code></span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../tuple/Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></code> in class <code><a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNominalEntries()"> +<h3>getNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNominalEntries</span>()</div> +<div class="block">Get configured nominal number of entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>nominal number of entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Get log_base2 of Nominal Entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>log_base2 of Nominal Entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamplingProbability()"> +<h3>getSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getSamplingProbability</span>()</div> +<div class="block">Get configured sampling probability</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>sampling probability</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentCapacity()"> +<h3>getCurrentCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentCapacity</span>()</div> +<div class="block">Get current capacity</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>current capacity</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Get configured resize factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>resize factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="trim()"> +<h3>trim</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">trim</span>()</div> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch an empty state.</div> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span> <span class="element-name">compact</span>()</div> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../tuple/Sketch.html#compact()">compact</a></code> in class <code><a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>compact sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</div> +</div> +<div class="block">This serializes an UpdatableSketch (QuickSelectSketch).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../tuple/Sketch.html#toByteArray()">toByteArray</a></code> in class <code><a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of an UpdatableSketch (QuickSelectSketch).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../tuple/TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="../tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../tuple/Sketch.html#iterator()">Sketch</a></code></span></div> +<div class="block">Returns a SketchIterator</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../tuple/Sketch.html#iterator()">iterator</a></code> in class <code><a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>a SketchIterator</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/Group.html b/docs/7.0.X/org/apache/datasketches/fdt/Group.html new file mode 100644 index 000000000..086dd889a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/Group.html @@ -0,0 +1,362 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Group (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.fdt, class: Group"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Group.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.fdt</a></div> +<h1 title="Class Group" class="title">Class Group</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.fdt.Group</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Group</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a>></span></div> +<div class="block">Defines a Group from a Frequent Distinct Tuple query. This class is called internally during + post processing and is not intended to be called by the user.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Group</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct an empty Group</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compareTo(org.apache.datasketches.fdt.Group)" class="member-name-link">compareTo</a><wbr>(<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a> that)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> that)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCount()" class="member-name-link">getCount</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFraction()" class="member-name-link">getFraction</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeader()" class="member-name-link">getHeader</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound()" class="member-name-link">getLowerBound</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPrimaryKey()" class="member-name-link">getPrimaryKey</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRse()" class="member-name-link">getRse</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound()" class="member-name-link">getUpperBound</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#init(java.lang.String,int,double,double,double,double,double)" class="member-name-link">init</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> priKey, + int count, + double estimate, + double ub, + double lb, + double fraction, + double rse)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Specifies the parameters to be listed as columns</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>Group</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Group</span>()</div> +<div class="block">Construct an empty Group</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="init(java.lang.String,int,double,double,double,double,double)"> +<h3>init</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a></span> <span class="element-name">init</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> priKey, + int count, + double estimate, + double ub, + double lb, + double fraction, + double rse)</span></div> +<div class="block">Specifies the parameters to be listed as columns</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>priKey</code> - the primary key of the FDT sketch</dd> +<dd><code>count</code> - the number of retained rows associated with this group</dd> +<dd><code>estimate</code> - the estimate of the original population associated with this group</dd> +<dd><code>ub</code> - the upper bound of the estimate</dd> +<dd><code>lb</code> - the lower bound of the estimate</dd> +<dd><code>fraction</code> - the fraction of all retained rows of the sketch associated with this group</dd> +<dd><code>rse</code> - the estimated Relative Standard Error for this group.</dd> +<dt>Returns:</dt> +<dd>return this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPrimaryKey()"> +<h3>getPrimaryKey</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getPrimaryKey</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>priKey of type T</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCount()"> +<h3>getCount</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCount</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the count</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the estimate</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound()"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the upper bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound()"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the lower bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFraction()"> +<h3>getFraction</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getFraction</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the fraction for this group</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRse()"> +<h3>getRse</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRse</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the RSE</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getHeader()"> +<h3>getHeader</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getHeader</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the descriptive header</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compareTo(org.apache.datasketches.fdt.Group)"> +<h3>compareTo</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">compareTo</span><wbr><span class="parameters">(<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a> that)</span></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>that</code> - The Group to compare to</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="equals(java.lang.Object)"> +<h3>equals</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> that)</span></div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashCode()"> +<h3>hashCode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/PostProcessor.html b/docs/7.0.X/org/apache/datasketches/fdt/PostProcessor.html new file mode 100644 index 000000000..91e50f5fd --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/PostProcessor.html @@ -0,0 +1,216 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>PostProcessor (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.fdt, class: PostProcessor"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/PostProcessor.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.fdt</a></div> +<h1 title="Class PostProcessor" class="title">Class PostProcessor</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.fdt.PostProcessor</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PostProcessor</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This processes the contents of a FDT sketch to extract the + primary keys with the most frequent unique combinations of the non-primary dimensions. + The source sketch is not modified.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch,org.apache.datasketches.fdt.Group,char)" class="member-name-link">PostProcessor</a><wbr>(<a href="FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> sketch, + <a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct with a populated FdtSketch</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGroupCount()" class="member-name-link">getGroupCount</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of groups in the final sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGroupList(int%5B%5D,int,int)" class="member-name-link">getGroupList</a><wbr>(int[] priKeyIndices, + int numStdDev, + int limit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return the most frequent Groups associated with Primary Keys based on the size of the groups.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.fdt.FdtSketch,org.apache.datasketches.fdt.Group,char)"> +<h3>PostProcessor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PostProcessor</span><wbr><span class="parameters">(<a href="FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> sketch, + <a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</span></div> +<div class="block">Construct with a populated FdtSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - the given sketch to query.</dd> +<dd><code>group</code> - the Group</dd> +<dd><code>sep</code> - the separator character</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getGroupCount()"> +<h3>getGroupCount</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getGroupCount</span>()</div> +<div class="block">Returns the number of groups in the final sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of groups in the final sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getGroupList(int[],int,int)"> +<h3>getGroupList</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a>></span> <span class="element-name">getGroupList</span><wbr><span class="parameters">(int[] priKeyIndices, + int numStdDev, + int limit)</span></div> +<div class="block">Return the most frequent Groups associated with Primary Keys based on the size of the groups.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>priKeyIndices</code> - the indices of the primary dimensions</dd> +<dd><code>numStdDev</code> - the number of standard deviations for the error bounds, this value is an + integer and must be one of 1, 2, or 3. + <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dd><code>limit</code> - the maximum number of rows to return. If ≤ 0, all rows will be returned.</dd> +<dt>Returns:</dt> +<dd>the most frequent Groups associated with Primary Keys based on the size of the groups.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/class-use/FdtSketch.html b/docs/7.0.X/org/apache/datasketches/fdt/class-use/FdtSketch.html new file mode 100644 index 000000000..2e512643f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/class-use/FdtSketch.html @@ -0,0 +1,107 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.fdt.FdtSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.fdt, class: FdtSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.fdt.FdtSketch" class="title">Uses of Class<br>org.apache.datasketches.fdt.FdtSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<h2>Uses of <a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> in <a href="../package-summary.html">org.apache.datasketches.fdt</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.fdt</a> that return <a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">FdtSketch.</span><code><a href="../FdtSketch.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.fdt</a> with parameters of type <a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../FdtSketch.html#%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch)" class="member-name-link">FdtSketch</a><wbr>(<a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Copy Constructor</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../PostProcessor.html#%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch,org.apache.datasketches.fdt.Group,char)" class="member-name-link">PostProcessor</a><wbr>(<a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> sketch, + <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct with a populated FdtSketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/class-use/Group.html b/docs/7.0.X/org/apache/datasketches/fdt/class-use/Group.html new file mode 100644 index 000000000..74bd2a46a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/class-use/Group.html @@ -0,0 +1,147 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.fdt.Group (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.fdt, class: Group"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Group.html" title="class in org.apache.datasketches.fdt">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.fdt.Group" class="title">Uses of Class<br>org.apache.datasketches.fdt.Group</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<h2>Uses of <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a> in <a href="../package-summary.html">org.apache.datasketches.fdt</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.fdt</a> that return <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Group.</span><code><a href="../Group.html#init(java.lang.String,int,double,double,double,double,double)" class="member-name-link">init</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> priKey, + int count, + double estimate, + double ub, + double lb, + double fraction, + double rse)</code></div> +<div class="col-last even-row-color"> +<div class="block">Specifies the parameters to be listed as columns</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.fdt</a> that return types with arguments of type <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">PostProcessor.</span><code><a href="../PostProcessor.html#getGroupList(int%5B%5D,int,int)" class="member-name-link">getGroupList</a><wbr>(int[] priKeyIndices, + int numStdDev, + int limit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Return the most frequent Groups associated with Primary Keys based on the size of the groups.</div> +</div> +<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">FdtSketch.</span><code><a href="../FdtSketch.html#getResult(int%5B%5D,int,int,char)" class="member-name-link">getResult</a><wbr>(int[] priKeyIndices, + int limit, + int numStdDev, + char sep)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an ordered List of Groups of the most frequent distinct population of subset tuples + represented by the count of entries of each group.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.fdt</a> with parameters of type <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Group.</span><code><a href="../Group.html#compareTo(org.apache.datasketches.fdt.Group)" class="member-name-link">compareTo</a><wbr>(<a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a> that)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">FdtSketch.</span><code><a href="../FdtSketch.html#getPostProcessor(org.apache.datasketches.fdt.Group,char)" class="member-name-link">getPostProcessor</a><wbr>(<a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.fdt</a> with parameters of type <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../PostProcessor.html#%3Cinit%3E(org.apache.datasketches.fdt.FdtSketch,org.apache.datasketches.fdt.Group,char)" class="member-name-link">PostProcessor</a><wbr>(<a href="../FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a> sketch, + <a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct with a populated FdtSketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/class-use/PostProcessor.html b/docs/7.0.X/org/apache/datasketches/fdt/class-use/PostProcessor.html new file mode 100644 index 000000000..7ec1dcb8f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/class-use/PostProcessor.html @@ -0,0 +1,97 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.fdt.PostProcessor (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.fdt, class: PostProcessor"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../PostProcessor.html" title="class in org.apache.datasketches.fdt">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.fdt.PostProcessor" class="title">Uses of Class<br>org.apache.datasketches.fdt.PostProcessor</h1> +</div> +<div class="caption"><span>Packages that use <a href="../PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<h2>Uses of <a href="../PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a> in <a href="../package-summary.html">org.apache.datasketches.fdt</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.fdt</a> that return <a href="../PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">FdtSketch.</span><code><a href="../FdtSketch.html#getPostProcessor()" class="member-name-link">getPostProcessor</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">FdtSketch.</span><code><a href="../FdtSketch.html#getPostProcessor(org.apache.datasketches.fdt.Group,char)" class="member-name-link">getPostProcessor</a><wbr>(<a href="../Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, + char sep)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/package-summary.html b/docs/7.0.X/org/apache/datasketches/fdt/package-summary.html new file mode 100644 index 000000000..bd4c67f27 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/package-summary.html @@ -0,0 +1,114 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.fdt (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.fdt"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.fdt" class="title">Package org.apache.datasketches.fdt</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.fdt</span></div> +<section class="package-description" id="package-description"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">A Frequent Distinct Tuples sketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Group.html" title="class in org.apache.datasketches.fdt">Group</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Defines a Group from a Frequent Distinct Tuple query.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This processes the contents of a FDT sketch to extract the + primary keys with the most frequent unique combinations of the non-primary dimensions.</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/package-tree.html b/docs/7.0.X/org/apache/datasketches/fdt/package-tree.html new file mode 100644 index 000000000..e60c45bc9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/package-tree.html @@ -0,0 +1,90 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.fdt Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.fdt"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.fdt</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.fdt.<a href="Group.html" class="type-name-link" title="class in org.apache.datasketches.fdt">Group</a> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>)</li> +<li class="circle">org.apache.datasketches.fdt.<a href="PostProcessor.html" class="type-name-link" title="class in org.apache.datasketches.fdt">PostProcessor</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="../tuple/Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><S> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="../tuple/UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S> +<ul> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="../tuple/strings/ArrayOfStringsSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> +<ul> +<li class="circle">org.apache.datasketches.fdt.<a href="FdtSketch.html" class="type-name-link" title="class in org.apache.datasketches.fdt">FdtSketch</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/fdt/package-use.html b/docs/7.0.X/org/apache/datasketches/fdt/package-use.html new file mode 100644 index 000000000..3476240c9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/fdt/package-use.html @@ -0,0 +1,97 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.fdt (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.fdt"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.fdt" class="title">Uses of Package<br>org.apache.datasketches.fdt</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.fdt</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.fdt</a> used by <a href="package-summary.html">org.apache.datasketches.fdt</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/FdtSketch.html#org.apache.datasketches.fdt">FdtSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">A Frequent Distinct Tuples sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Group.html#org.apache.datasketches.fdt">Group</a></div> +<div class="col-last odd-row-color"> +<div class="block">Defines a Group from a Frequent Distinct Tuple query.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/PostProcessor.html#org.apache.datasketches.fdt">PostProcessor</a></div> +<div class="col-last even-row-color"> +<div class="block">This processes the contents of a FDT sketch to extract the + primary keys with the most frequent unique combinations of the non-primary dimensions.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/BloomFilter.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/BloomFilter.html new file mode 100644 index 000000000..9974c3d17 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/BloomFilter.html @@ -0,0 +1,1081 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BloomFilter (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.filters.bloomfilter, class: BloomFilter"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BloomFilter.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.filters.bloomfilter</a></div> +<h1 title="Class BloomFilter" class="title">Class BloomFilter</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.filters.bloomfilter.BloomFilter</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BloomFilter</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A Bloom filter is a data structure that can be used for probabilistic + set membership. + + <p>When querying a Bloom filter, there are no false positives. Specifically: + When querying an item that has already been inserted to the filter, the filter will + always indicate that the item is present. There is a chance of false positives, where + querying an item that has never been presented to the filter will indicate that the + item has already been seen. Consequently, any query should be interpreted as + "might have seen."</p> + + <p>A standard Bloom filter is unlike typical sketches in that it is not sub-linear + in size and does not resize itself. A Bloom filter will work up to a target number of + distinct items, beyond which it will saturate and the false positive rate will start to + increase. The size of a Bloom filter will be linear in the expected number of + distinct items.</p> + + <p>See the BloomFilterBuilder class for methods to create a filter, especially + one sized correctly for a target number of distinct elements and a target + false positive probability.</p> + + <p>This implementation uses xxHash64 and follows the approach in Kirsch and Mitzenmacher, + "Less Hashing, Same Performance: Building a Better Bloom Filter," Wiley Interscience, 2008, pp. 187-218.</p></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final long</code></div> +<div class="col-second even-row-color"><code><a href="#MAX_SIZE_BITS" class="member-name-link">MAX_SIZE_BITS</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The maximum size of a bloom filter in bits.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBitsUsed()" class="member-name-link">getBitsUsed</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of bits in the BloomFilter that are set to 1.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCapacity()" class="member-name-link">getCapacity</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the total number of bits in the BloomFilter.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFillPercentage()" class="member-name-link">getFillPercentage</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the percentage of all bits in the BloomFilter set to 1.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>short</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumHashes()" class="member-name-link">getNumHashes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the configured number of hash functions for this BloomFilter</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSeed()" class="member-name-link">getSeed</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the hash seed for this BloomFilter.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializedSize(long)" class="member-name-link">getSerializedSize</a><wbr>(long numBits)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the serialized length of a non-empty BloomFilter of the given size, in bytes</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the length of this BloomFilter when serialized, in bytes</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns whether the filter has a backing Memory object</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Reads a serialized image of a BloomFilter from the provided Memory</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersect(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">intersect</a><wbr>(<a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Intersects two BloomFilters by applying a logical AND.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#invert()" class="member-name-link">invert</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Inverts all the bits of the BloomFilter.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCompatible(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">isCompatible</a><wbr>(<a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Helps identify if two BloomFilters may be unioned or intersected.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns whether the filter is a direct (off-heap) or on-heap object.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Checks if the BloomFilter has processed any items</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns whether the filter is in read-only mode.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(byte%5B%5D)" class="member-name-link">query</a><wbr>(byte[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided byte[] and returns whether the + array <em>might</em> have been seen previously.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(char%5B%5D)" class="member-name-link">query</a><wbr>(char[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided char[] and returns whether the + array <em>might</em> have been seen previously.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(double)" class="member-name-link">query</a><wbr>(double item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided double and returns whether the + value <em>might</em> have been seen previously.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(int%5B%5D)" class="member-name-link">query</a><wbr>(int[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided int[] and returns whether the + array <em>might</em> have been seen previously.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(long)" class="member-name-link">query</a><wbr>(long item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided long and returns whether the + value <em>might</em> have been seen previously.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(long%5B%5D)" class="member-name-link">query</a><wbr>(long[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided long[] and returns whether the + array <em>might</em> have been seen previously.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(short%5B%5D)" class="member-name-link">query</a><wbr>(short[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided short[] and returns whether the + array <em>might</em> have been seen previously.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(java.lang.String)" class="member-name-link">query</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided double and returns whether the + value <em>might</em> have been seen previously.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(org.apache.datasketches.memory.Memory)" class="member-name-link">query</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Queries the filter with the provided Memory and returns whether the + data <em>might</em> have been seen previously.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(byte%5B%5D)" class="member-name-link">queryAndUpdate</a><wbr>(byte[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided byte[] and + returns the result from quering that array prior to the update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(char%5B%5D)" class="member-name-link">queryAndUpdate</a><wbr>(char[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided char[] and + returns the result from quering that array prior to the update.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(double)" class="member-name-link">queryAndUpdate</a><wbr>(double item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided double and + returns the result from quering that value prior to the update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(int%5B%5D)" class="member-name-link">queryAndUpdate</a><wbr>(int[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided int[] and + returns the result from quering that array prior to the update.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(long)" class="member-name-link">queryAndUpdate</a><wbr>(long item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided long and + returns the result from quering that value prior to the update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(long%5B%5D)" class="member-name-link">queryAndUpdate</a><wbr>(long[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided long[] and + returns the result from quering that array prior to the update.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(short%5B%5D)" class="member-name-link">queryAndUpdate</a><wbr>(short[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided short[] and + returns the result from quering that array prior to the update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(java.lang.String)" class="member-name-link">queryAndUpdate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided String and + returns the result from quering that value prior to the update.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryAndUpdate(org.apache.datasketches.memory.Memory)" class="member-name-link">queryAndUpdate</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided Memory and + returns the result from quering that Memory prior to the update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets the BloomFilter to an empty state</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serializes the current BloomFilter to an array of bytes.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toLongArray()" class="member-name-link">toLongArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serializes the current BloomFilter to an array of longs.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">union</a><wbr>(<a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Unions two BloomFilters by applying a logical OR.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided byte[].</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(char%5B%5D)" class="member-name-link">update</a><wbr>(char[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided char[].</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided double value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(int%5B%5D)" class="member-name-link">update</a><wbr>(int[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided int[].</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided long value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D)" class="member-name-link">update</a><wbr>(long[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided long[].</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(short%5B%5D)" class="member-name-link">update</a><wbr>(short[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided short[].</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the provided String.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.memory.Memory)" class="member-name-link">update</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the filter with the data in the provided Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wraps the given Memory into this filter class.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory wmem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wraps the given WritableMemory into this filter class.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="MAX_SIZE_BITS"> +<h3>MAX_SIZE_BITS</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name">MAX_SIZE_BITS</span></div> +<div class="block">The maximum size of a bloom filter in bits.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Reads a serialized image of a BloomFilter from the provided Memory</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory containing a previously serialized BloomFilter</dd> +<dt>Returns:</dt> +<dd>a BloomFilter object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Wraps the given Memory into this filter class. The class itself only contains a few metadata items and holds + a reference to the Memory object, which contains all the data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory object</dd> +<dt>Returns:</dt> +<dd>the wrapping BloomFilter class.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="writableWrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>writableWrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">writableWrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory wmem)</span></div> +<div class="block">Wraps the given WritableMemory into this filter class. The class itself only contains a few metadata items and holds + a reference to the Memory object, which contains all the data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>wmem</code> - the given WritableMemory object</dd> +<dt>Returns:</dt> +<dd>the wrapping BloomFilter class.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets the BloomFilter to an empty state</div> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Checks if the BloomFilter has processed any items</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>True if the BloomFilter is empty, otherwise False</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getBitsUsed()"> +<h3>getBitsUsed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getBitsUsed</span>()</div> +<div class="block">Returns the number of bits in the BloomFilter that are set to 1.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The number of bits in use in this filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCapacity()"> +<h3>getCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getCapacity</span>()</div> +<div class="block">Returns the total number of bits in the BloomFilter.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The total size of the BloomFilter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumHashes()"> +<h3>getNumHashes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">short</span> <span class="element-name">getNumHashes</span>()</div> +<div class="block">Returns the configured number of hash functions for this BloomFilter</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The number of hash functions to apply to inputs</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSeed()"> +<h3>getSeed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getSeed</span>()</div> +<div class="block">Returns the hash seed for this BloomFilter.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The hash seed for this filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block">Returns whether the filter has a backing Memory object</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if backed by Memory, otherwise false</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +<div class="block">Returns whether the filter is in read-only mode. That is possible + only if there is a backing Memory in read-only mode.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if read-only, otherwise false</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block">Returns whether the filter is a direct (off-heap) or on-heap object. + That is possible only if there is a backing Memory.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if using direct memory access, otherwise false</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFillPercentage()"> +<h3>getFillPercentage</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getFillPercentage</span>()</div> +<div class="block">Returns the percentage of all bits in the BloomFilter set to 1.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the percentage of bits in the filter set to 1</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Updates the filter with the provided long value.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double item)</span></div> +<div class="block">Updates the filter with the provided double value. The value is + canonicalized (NaN and infinities) prior to updating.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block">Updates the filter with the provided String. + The string is converted to a byte array using UTF8 encoding. + + <p>Note: this will not produce the same output hash values as the <a href="#update(char%5B%5D)"><code>update(char[])</code></a> + method and will generally be a little slower depending on the complexity of the UTF8 encoding. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Updates the filter with the provided byte[].</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(char[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Updates the filter with the provided char[].</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(short[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(short[] data)</span></div> +<div class="block">Updates the filter with the provided short[].</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Updates the filter with the provided int[].</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Updates the filter with the provided long[].</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.memory.Memory)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Updates the filter with the data in the provided Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - a Memory object with which to update the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(long)"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Updates the filter with the provided long and + returns the result from quering that value prior to the update.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(double)"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(double item)</span></div> +<div class="block">Updates the filter with the provided double and + returns the result from quering that value prior to the update. + The double is canonicalized (NaN and +/- infinity) in the call.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(java.lang.String)"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block">Updates the filter with the provided String and + returns the result from quering that value prior to the update. + The string is converted to a byte array using UTF8 encoding. + + <p>Note: this will not produce the same output hash values as the <a href="#queryAndUpdate(char%5B%5D)"><code>queryAndUpdate(char[])</code></a> + method and will generally be a little slower depending on the complexity of the UTF8 encoding. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update, or false if item is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(byte[])"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Updates the filter with the provided byte[] and + returns the result from quering that array prior to the update.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(char[])"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Updates the filter with the provided char[] and + returns the result from quering that array prior to the update.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(short[])"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(short[] data)</span></div> +<div class="block">Updates the filter with the provided short[] and + returns the result from quering that array prior to the update.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(int[])"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Updates the filter with the provided int[] and + returns the result from quering that array prior to the update.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(long[])"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Updates the filter with the provided long[] and + returns the result from quering that array prior to the update.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="queryAndUpdate(org.apache.datasketches.memory.Memory)"> +<h3>queryAndUpdate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">queryAndUpdate</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Updates the filter with the provided Memory and + returns the result from quering that Memory prior to the update.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - an array with which to update the filter</dd> +<dt>Returns:</dt> +<dd>The query result prior to applying the update, or false if mem is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(long)"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Queries the filter with the provided long and returns whether the + value <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(double)"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(double item)</span></div> +<div class="block">Queries the filter with the provided double and returns whether the + value <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible. Double values are + canonicalized (NaN and +/- infinity) before querying.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(java.lang.String)"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> item)</span></div> +<div class="block">Queries the filter with the provided double and returns whether the + value <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible. + The string is converted to a byte array using UTF8 encoding. + + <p>Note: this will not produce the same output hash values as the <a href="#update(char%5B%5D)"><code>update(char[])</code></a> + method and will generally be a little slower depending on the complexity of the UTF8 encoding. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given item, or false if item is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(byte[])"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Queries the filter with the provided byte[] and returns whether the + array <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given data, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(char[])"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Queries the filter with the provided char[] and returns whether the + array <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given data, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(short[])"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(short[] data)</span></div> +<div class="block">Queries the filter with the provided short[] and returns whether the + array <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given data, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(int[])"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Queries the filter with the provided int[] and returns whether the + array <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given data, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(long[])"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Queries the filter with the provided long[] and returns whether the + array <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - an array with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given data, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="query(org.apache.datasketches.memory.Memory)"> +<h3>query</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">query</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Queries the filter with the provided Memory and returns whether the + data <em>might</em> have been seen previously. The filter's expected + False Positive Probability determines the chances of a true result being + a false positive. False negatives are never possible.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - a Memory array with which to query the filter</dd> +<dt>Returns:</dt> +<dd>The result of querying the filter with the given Memory, or false if data is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.filters.bloomfilter.BloomFilter)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</span></div> +<div class="block">Unions two BloomFilters by applying a logical OR. The result will recognized + any values seen by either filter (as well as false positives).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - A BloomFilter to union with this one</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersect(org.apache.datasketches.filters.bloomfilter.BloomFilter)"> +<h3>intersect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</span></div> +<div class="block">Intersects two BloomFilters by applying a logical AND. The result will recognize + only values seen by both filters (as well as false positives).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - A BloomFilter to union with this one</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="invert()"> +<h3>invert</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">invert</span>()</div> +<div class="block">Inverts all the bits of the BloomFilter. Approximately inverts the notion of set-membership.</div> +</section> +</li> +<li> +<section class="detail" id="isCompatible(org.apache.datasketches.filters.bloomfilter.BloomFilter)"> +<h3>isCompatible</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCompatible</span><wbr><span class="parameters">(<a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</span></div> +<div class="block">Helps identify if two BloomFilters may be unioned or intersected.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - A BloomFilter to check for compatibility with this one</dd> +<dt>Returns:</dt> +<dd>True if the filters are compatible, otherwise false</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes()"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getSerializedSizeBytes</span>()</div> +<div class="block">Returns the length of this BloomFilter when serialized, in bytes</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The length of this BloomFilter when serialized, in bytes</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSize(long)"> +<h3>getSerializedSize</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">getSerializedSize</span><wbr><span class="parameters">(long numBits)</span></div> +<div class="block">Returns the serialized length of a non-empty BloomFilter of the given size, in bytes</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numBits</code> - The number of bits of to use for size computation</dd> +<dt>Returns:</dt> +<dd>The serialized length of a non-empty BloomFilter of the given size, in bytes</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Serializes the current BloomFilter to an array of bytes. + + <p>Note: Method throws if the serialized size exceeds <code>Integer.MAX_VALUE</code>.</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>A serialized image of the current BloomFilter as byte[]</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toLongArray()"> +<h3>toLongArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">toLongArray</span>()</div> +<div class="block">Serializes the current BloomFilter to an array of longs. Unlike <a href="#toByteArray()"><code>toByteArray()</code></a>, + this method can handle any size filter.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>A serialized image of the current BloomFilter as long[]</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html new file mode 100644 index 000000000..5c9063e37 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html @@ -0,0 +1,476 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BloomFilterBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.filters.bloomfilter, class: BloomFilterBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BloomFilterBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.filters.bloomfilter</a></div> +<h1 title="Class BloomFilterBuilder" class="title">Class BloomFilterBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.filters.bloomfilter.BloomFilterBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BloomFilterBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class provides methods to help estimate the correct parameters when + creating a Bloom filter, and methods to create the filter using those values. + + <p>The underlying math is described in the + <a href='https://en.wikipedia.org/wiki/Bloom_filter#Optimal_number_of_hash_functions'> + Wikipedia article on Bloom filters</a>.</p></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BloomFilterBuilder</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createByAccuracy(long,double)" class="member-name-link">createByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createByAccuracy(long,double,long)" class="member-name-link">createByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createBySize(long,int)" class="member-name-link">createBySize</a><wbr>(long numBits, + int numHashes)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using a rnadom base seed for the hash function.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createBySize(long,int,long)" class="member-name-link">createBySize</a><wbr>(long numBits, + int numHashes, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializedFilterSize(long)" class="member-name-link">getSerializedFilterSize</a><wbr>(long numBits)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the minimum memory size, in bytes, needed for a serialized BloomFilter with the given number of bits.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializedFilterSizeByAccuracy(long,double)" class="member-name-link">getSerializedFilterSizeByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the minimum memory size, in bytes, needed for a serialized BloomFilter with an optimal number of bits + and hash functions for the given inputs.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#initializeByAccuracy(long,double,long,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb, + long seed, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#initializeByAccuracy(long,double,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#initializeBySize(long,int,long,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeBySize</a><wbr>(long numBits, + int numHashes, + long seed, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#initializeBySize(long,int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeBySize</a><wbr>(long numBits, + int numHashes, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#suggestNumFilterBits(long,double)" class="member-name-link">suggestNumFilterBits</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the optimal number of bits to use in a Bloom Filter given a target number of distinct + items and a target false positive probability.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static short</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#suggestNumHashes(double)" class="member-name-link">suggestNumHashes</a><wbr>(double targetFalsePositiveProb)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the optimal number of hash functions to achieve a target false positive probability.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static short</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#suggestNumHashes(long,long)" class="member-name-link">suggestNumHashes</a><wbr>(long maxDistinctItems, + long numFilterBits)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the optimal number of hash functions to given target numbers of distinct items + and the BloomFilter size in bits.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>BloomFilterBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BloomFilterBuilder</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="suggestNumHashes(long,long)"> +<h3>suggestNumHashes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">short</span> <span class="element-name">suggestNumHashes</span><wbr><span class="parameters">(long maxDistinctItems, + long numFilterBits)</span></div> +<div class="block">Returns the optimal number of hash functions to given target numbers of distinct items + and the BloomFilter size in bits. This function will provide a result even if the input + values exceed the capacity of a single BloomFilter.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxDistinctItems</code> - The maximum expected number of distinct items to add to the filter</dd> +<dd><code>numFilterBits</code> - The intended size of the Bloom Filter in bits</dd> +<dt>Returns:</dt> +<dd>The suggested number of hash functions to use with the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="suggestNumHashes(double)"> +<h3>suggestNumHashes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">short</span> <span class="element-name">suggestNumHashes</span><wbr><span class="parameters">(double targetFalsePositiveProb)</span></div> +<div class="block">Returns the optimal number of hash functions to achieve a target false positive probability.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>targetFalsePositiveProb</code> - A desired false positive probability per item</dd> +<dt>Returns:</dt> +<dd>The suggested number of hash functions to use with the filter.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="suggestNumFilterBits(long,double)"> +<h3>suggestNumFilterBits</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">suggestNumFilterBits</span><wbr><span class="parameters">(long maxDistinctItems, + double targetFalsePositiveProb)</span></div> +<div class="block">Returns the optimal number of bits to use in a Bloom Filter given a target number of distinct + items and a target false positive probability.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxDistinctItems</code> - The maximum expected number of distinct items to add to the filter</dd> +<dd><code>targetFalsePositiveProb</code> - A desired false positive probability per item</dd> +<dt>Returns:</dt> +<dd>The suggested number of bits to use with the filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedFilterSizeByAccuracy(long,double)"> +<h3>getSerializedFilterSizeByAccuracy</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">getSerializedFilterSizeByAccuracy</span><wbr><span class="parameters">(long maxDistinctItems, + double targetFalsePositiveProb)</span></div> +<div class="block">Returns the minimum memory size, in bytes, needed for a serialized BloomFilter with an optimal number of bits + and hash functions for the given inputs. This is also the minimum size of a WritableMemory for + in-place filter initialization.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxDistinctItems</code> - The maximum expected number of distinct items to add to the filter</dd> +<dd><code>targetFalsePositiveProb</code> - A desired false positive probability per item</dd> +<dt>Returns:</dt> +<dd>The size, in bytes, required to hold the specified BloomFilter when serialized</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedFilterSize(long)"> +<h3>getSerializedFilterSize</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">getSerializedFilterSize</span><wbr><span class="parameters">(long numBits)</span></div> +<div class="block">Returns the minimum memory size, in bytes, needed for a serialized BloomFilter with the given number of bits. + This is also the minimum size of a WritableMemory for in-place filter initialization.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numBits</code> - The number of bits in the target BloomFilter's bit array.</dd> +<dt>Returns:</dt> +<dd>The size, in bytes, required to hold the specified BloomFilter when serialized</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="createByAccuracy(long,double)"> +<h3>createByAccuracy</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">createByAccuracy</span><wbr><span class="parameters">(long maxDistinctItems, + double targetFalsePositiveProb)</span></div> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxDistinctItems</code> - The maximum expected number of distinct items to add to the filter</dd> +<dd><code>targetFalsePositiveProb</code> - A desired false positive probability per item</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="createByAccuracy(long,double,long)"> +<h3>createByAccuracy</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">createByAccuracy</span><wbr><span class="parameters">(long maxDistinctItems, + double targetFalsePositiveProb, + long seed)</span></div> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxDistinctItems</code> - The maximum expected number of distinct items to add to the filter</dd> +<dd><code>targetFalsePositiveProb</code> - A desired false positive probability per item</dd> +<dd><code>seed</code> - A base hash seed</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="createBySize(long,int)"> +<h3>createBySize</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">createBySize</span><wbr><span class="parameters">(long numBits, + int numHashes)</span></div> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using a rnadom base seed for the hash function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numBits</code> - The size of the BloomFilter, in bits</dd> +<dd><code>numHashes</code> - The number of hash functions to apply to items</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="createBySize(long,int,long)"> +<h3>createBySize</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">createBySize</span><wbr><span class="parameters">(long numBits, + int numHashes, + long seed)</span></div> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numBits</code> - The size of the BloomFilter, in bits</dd> +<dd><code>numHashes</code> - The number of hash functions to apply to items</dd> +<dd><code>seed</code> - A base hash seed</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="initializeByAccuracy(long,double,org.apache.datasketches.memory.WritableMemory)"> +<h3>initializeByAccuracy</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">initializeByAccuracy</span><wbr><span class="parameters">(long maxDistinctItems, + double targetFalsePositiveProb, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxDistinctItems</code> - The maximum expected number of distinct items to add to the filter</dd> +<dd><code>targetFalsePositiveProb</code> - A desired false positive probability per item</dd> +<dd><code>dstMem</code> - A WritableMemory to hold the initialized filter</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="initializeByAccuracy(long,double,long,org.apache.datasketches.memory.WritableMemory)"> +<h3>initializeByAccuracy</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">initializeByAccuracy</span><wbr><span class="parameters">(long maxDistinctItems, + double targetFalsePositiveProb, + long seed, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxDistinctItems</code> - The maximum expected number of distinct items to add to the filter</dd> +<dd><code>targetFalsePositiveProb</code> - A desired false positive probability per item</dd> +<dd><code>seed</code> - A base hash seed</dd> +<dd><code>dstMem</code> - A WritableMemory to hold the initialized filter</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="initializeBySize(long,int,org.apache.datasketches.memory.WritableMemory)"> +<h3>initializeBySize</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">initializeBySize</span><wbr><span class="parameters">(long numBits, + int numHashes, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numBits</code> - The size of the BloomFilter, in bits</dd> +<dd><code>numHashes</code> - The number of hash functions to apply to items</dd> +<dd><code>dstMem</code> - A WritableMemory to hold the initialized filter</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="initializeBySize(long,int,long,org.apache.datasketches.memory.WritableMemory)"> +<h3>initializeBySize</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span> <span class="element-name">initializeBySize</span><wbr><span class="parameters">(long numBits, + int numHashes, + long seed, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numBits</code> - The size of the BloomFilter, in bits</dd> +<dd><code>numHashes</code> - The number of hash functions to apply to items</dd> +<dd><code>seed</code> - A base hash seed</dd> +<dd><code>dstMem</code> - A WritableMemory to hold the initialized filter</dd> +<dt>Returns:</dt> +<dd>A new BloomFilter configured for the given input parameters</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html new file mode 100644 index 000000000..e1233eb86 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html @@ -0,0 +1,168 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DirectBitArrayR (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.filters.bloomfilter, class: DirectBitArrayR"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DirectBitArrayR.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.filters.bloomfilter</a></div> +<h1 title="Class DirectBitArrayR" class="title">Class DirectBitArrayR</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.filters.bloomfilter.DirectBitArrayR</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DirectBitArrayR</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class can maintain the BitArray object off-heap.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +</section> +</li> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/BloomFilter.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/BloomFilter.html new file mode 100644 index 000000000..35425b2a8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/BloomFilter.html @@ -0,0 +1,186 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.filters.bloomfilter.BloomFilter (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.filters.bloomfilter, class: BloomFilter"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.filters.bloomfilter.BloomFilter" class="title">Uses of Class<br>org.apache.datasketches.filters.bloomfilter.BloomFilter</h1> +</div> +<div class="caption"><span>Packages that use <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.filters.bloomfilter">org.apache.datasketches.filters.bloomfilter</a></div> +<div class="col-last even-row-color"> +<div class="block">BloomFilter package</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.filters.bloomfilter"> +<h2>Uses of <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> in <a href="../package-summary.html">org.apache.datasketches.filters.bloomfilter</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.filters.bloomfilter</a> that return <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#createByAccuracy(long,double)" class="member-name-link">createByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#createByAccuracy(long,double,long)" class="member-name-link">createByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#createBySize(long,int)" class="member-name-link">createBySize</a><wbr>(long numBits, + int numHashes)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using a rnadom base seed for the hash function.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#createBySize(long,int,long)" class="member-name-link">createBySize</a><wbr>(long numBits, + int numHashes, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilter.</span><code><a href="../BloomFilter.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Reads a serialized image of a BloomFilter from the provided Memory</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#initializeByAccuracy(long,double,long,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb, + long seed, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#initializeByAccuracy(long,double,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeByAccuracy</a><wbr>(long maxDistinctItems, + double targetFalsePositiveProb, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates a new BloomFilter with an optimal number of bits and hash functions for the given inputs, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#initializeBySize(long,int,long,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeBySize</a><wbr>(long numBits, + int numHashes, + long seed, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using the provided base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilterBuilder.</span><code><a href="../BloomFilterBuilder.html#initializeBySize(long,int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">initializeBySize</a><wbr>(long numBits, + int numHashes, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Initializes a BloomFilter with given number of bits and number of hash functions, + using a random base seed for the hash function and writing into the provided WritableMemory.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BloomFilter.</span><code><a href="../BloomFilter.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wraps the given Memory into this filter class.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilter.</span><code><a href="../BloomFilter.html#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory wmem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wraps the given WritableMemory into this filter class.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.filters.bloomfilter</a> with parameters of type <a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilter.</span><code><a href="../BloomFilter.html#intersect(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">intersect</a><wbr>(<a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">Intersects two BloomFilters by applying a logical AND.</div> +</div> +<div class="col-first odd-row-color"><code>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BloomFilter.</span><code><a href="../BloomFilter.html#isCompatible(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">isCompatible</a><wbr>(<a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Helps identify if two BloomFilters may be unioned or intersected.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BloomFilter.</span><code><a href="../BloomFilter.html#union(org.apache.datasketches.filters.bloomfilter.BloomFilter)" class="member-name-link">union</a><wbr>(<a href="../BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">Unions two BloomFilters by applying a logical OR.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/BloomFilterBuilder.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/BloomFilterBuilder.html new file mode 100644 index 000000000..b8e0671e5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/BloomFilterBuilder.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.filters.bloomfilter.BloomFilterBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.filters.bloomfilter, class: BloomFilterBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.filters.bloomfilter.BloomFilterBuilder" class="title">Uses of Class<br>org.apache.datasketches.filters.bloomfilter.BloomFilterBuilder</h1> +</div> +No usage of org.apache.datasketches.filters.bloomfilter.BloomFilterBuilder</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/DirectBitArrayR.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/DirectBitArrayR.html new file mode 100644 index 000000000..e3f633c61 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/class-use/DirectBitArrayR.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.filters.bloomfilter.DirectBitArrayR (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.filters.bloomfilter, class: DirectBitArrayR"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DirectBitArrayR.html" title="class in org.apache.datasketches.filters.bloomfilter">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.filters.bloomfilter.DirectBitArrayR" class="title">Uses of Class<br>org.apache.datasketches.filters.bloomfilter.DirectBitArrayR</h1> +</div> +No usage of org.apache.datasketches.filters.bloomfilter.DirectBitArrayR</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-summary.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-summary.html new file mode 100644 index 000000000..d8701de36 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-summary.html @@ -0,0 +1,116 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.filters.bloomfilter (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.filters.bloomfilter"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.filters.bloomfilter" class="title">Package org.apache.datasketches.filters.bloomfilter</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.filters.bloomfilter</span></div> +<section class="package-description" id="package-description"> +<div class="block">BloomFilter package</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches.filters</a></div> +<div class="col-last even-row-color"> +<div class="block">The filters package contains data structures used to determine + approximate set-membership.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">A Bloom filter is a data structure that can be used for probabilistic + set membership.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BloomFilterBuilder.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This class provides methods to help estimate the correct parameters when + creating a Bloom filter, and methods to create the filter using those values.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DirectBitArrayR.html" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This class can maintain the BitArray object off-heap.</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-tree.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-tree.html new file mode 100644 index 000000000..5124a6357 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-tree.html @@ -0,0 +1,78 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.filters.bloomfilter Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.filters.bloomfilter"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.filters.bloomfilter</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.filters.bloomfilter.<a href="BloomFilter.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></li> +<li class="circle">org.apache.datasketches.filters.bloomfilter.<a href="BloomFilterBuilder.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></li> +<li class="circle">org.apache.datasketches.filters.bloomfilter.<a href="DirectBitArrayR.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-use.html b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-use.html new file mode 100644 index 000000000..99ea18b29 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/bloomfilter/package-use.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.filters.bloomfilter (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.filters.bloomfilter"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.filters.bloomfilter" class="title">Uses of Package<br>org.apache.datasketches.filters.bloomfilter</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.filters.bloomfilter</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.filters.bloomfilter">org.apache.datasketches.filters.bloomfilter</a></div> +<div class="col-last even-row-color"> +<div class="block">BloomFilter package</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.filters.bloomfilter"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.filters.bloomfilter</a> used by <a href="package-summary.html">org.apache.datasketches.filters.bloomfilter</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/BloomFilter.html#org.apache.datasketches.filters.bloomfilter">BloomFilter</a></div> +<div class="col-last even-row-color"> +<div class="block">A Bloom filter is a data structure that can be used for probabilistic + set membership.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/package-summary.html b/docs/7.0.X/org/apache/datasketches/filters/package-summary.html new file mode 100644 index 000000000..8eeb98465 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/package-summary.html @@ -0,0 +1,100 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.filters (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.filters"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li>Classes and Interfaces</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.filters" class="title">Package org.apache.datasketches.filters</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.filters</span></div> +<section class="package-description" id="package-description"> +<div class="block">The filters package contains data structures used to determine + approximate set-membership. Classes in this package may not follow + the standard sub-linear properties of other offerings in this + library, but they fit with the spirit of DataSketches by providing + fast and approximate answers to complex problems.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +<div class="col-first odd-row-color"><a href="bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a></div> +<div class="col-last odd-row-color"> +<div class="block">BloomFilter package</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/package-tree.html b/docs/7.0.X/org/apache/datasketches/filters/package-tree.html new file mode 100644 index 000000000..295dca735 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/package-tree.html @@ -0,0 +1,66 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.filters Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.filters"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.filters</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/filters/package-use.html b/docs/7.0.X/org/apache/datasketches/filters/package-use.html new file mode 100644 index 000000000..c54489524 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/filters/package-use.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.filters (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.filters"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.filters" class="title">Uses of Package<br>org.apache.datasketches.filters</h1> +</div> +No usage of org.apache.datasketches.filters</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/ErrorType.html b/docs/7.0.X/org/apache/datasketches/frequencies/ErrorType.html new file mode 100644 index 000000000..f967edad8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/ErrorType.html @@ -0,0 +1,239 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ErrorType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.frequencies, enum: ErrorType"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ErrorType.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.frequencies</a></div> +<h1 title="Enum Class ErrorType" class="title">Enum Class ErrorType</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a>> +<div class="inheritance">org.apache.datasketches.frequencies.ErrorType</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">ErrorType</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a>></span></div> +<div class="block">Specifies one of two types of error regions of the statistical classification Confusion Matrix + that can be excluded from a returned sample of Frequent Items.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#NO_FALSE_NEGATIVES" class="member-name-link">NO_FALSE_NEGATIVES</a></code></div> +<div class="col-last even-row-color"> +<div class="block">No <i>Type II</i> error samples will be excluded from the sample set, + which means all <i>Truly Positive</i> samples will be included in the sample set.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#NO_FALSE_POSITIVES" class="member-name-link">NO_FALSE_POSITIVES</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">No <i>Type I</i> error samples will be included in the sample set, + which means all <i>Truly Negative</i> samples will be excluded from the sample set.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="NO_FALSE_POSITIVES"> +<h3>NO_FALSE_POSITIVES</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></span> <span class="element-name">NO_FALSE_POSITIVES</span></div> +<div class="block">No <i>Type I</i> error samples will be included in the sample set, + which means all <i>Truly Negative</i> samples will be excluded from the sample set. + However, there may be <i>Type II</i> error samples (<i>False Negatives</i>) + that should have been included that were not. + This is a subset of the NO_FALSE_NEGATIVES ErrorType.</div> +</section> +</li> +<li> +<section class="detail" id="NO_FALSE_NEGATIVES"> +<h3>NO_FALSE_NEGATIVES</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></span> <span class="element-name">NO_FALSE_NEGATIVES</span></div> +<div class="block">No <i>Type II</i> error samples will be excluded from the sample set, + which means all <i>Truly Positive</i> samples will be included in the sample set. + However, there may be <i>Type I</i> error samples (<i>False Positives</i>) + that were included that should not have been.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/ItemsSketch.Row.html b/docs/7.0.X/org/apache/datasketches/frequencies/ItemsSketch.Row.html new file mode 100644 index 000000000..b83b465e9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/ItemsSketch.Row.html @@ -0,0 +1,287 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ItemsSketch.Row (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.frequencies, class: ItemsSketch, class: Row"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ItemsSketch.Row.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.frequencies</a></div> +<h1 title="Class ItemsSketch.Row" class="title">Class ItemsSketch.Row<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.frequencies.ItemsSketch.Row<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - type of item</dd> +</dl> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><T>></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">ItemsSketch.Row<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><T>></span></div> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compareTo(org.apache.datasketches.frequencies.ItemsSketch.Row)" class="member-name-link">compareTo</a><wbr>(<a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>> that)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This equals is computed only from the Row.getEstimate() value and does not imply equality + of the other items within the row: item and upper and lower bounds.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getItem()" class="member-name-link">getItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound()" class="member-name-link">getLowerBound</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRowHeader()" class="member-name-link">getRowHeader</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound()" class="member-name-link">getUpperBound</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This hashCode is computed only from the Row.getEstimate() value.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getItem()"> +<h3>getItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a></span> <span class="element-name">getItem</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>item of type T</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEstimate</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the estimate</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound()"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getUpperBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the upper bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound()"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLowerBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>return the lower bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRowHeader()"> +<h3>getRowHeader</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getRowHeader</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the descriptive row header</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compareTo(org.apache.datasketches.frequencies.ItemsSketch.Row)"> +<h3>compareTo</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">compareTo</span><wbr><span class="parameters">(<a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>> that)</span></div> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds. + Defined this way, this compareTo will be consistent with hashCode() and equals(Object).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>that</code> - the other row to compare to.</dd> +<dt>Returns:</dt> +<dd>a negative integer, zero, or a positive integer as this.getEstimate() is less than, + equal to, or greater than that.getEstimate().</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashCode()"> +<h3>hashCode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> +<div class="block">This hashCode is computed only from the Row.getEstimate() value. + Defined this way, this hashCode will be consistent with equals(Object):<br> + If (x.equals(y)) implies: x.hashCode() == y.hashCode().<br> + If (!x.equals(y)) does NOT imply: x.hashCode() != y.hashCode().</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>the hashCode computed from getEstimate().</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="equals(java.lang.Object)"> +<h3>equals</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div> +<div class="block">This equals is computed only from the Row.getEstimate() value and does not imply equality + of the other items within the row: item and upper and lower bounds. + Defined this way, this equals will be consistent with compareTo(Row).</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Parameters:</dt> +<dd><code>obj</code> - the other row to determine equality with.</dd> +<dt>Returns:</dt> +<dd>true if this.getEstimate() equals ((Row<T>)obj).getEstimate().</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/ItemsSketch.html b/docs/7.0.X/org/apache/datasketches/frequencies/ItemsSketch.html new file mode 100644 index 000000000..757b11756 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/ItemsSketch.html @@ -0,0 +1,697 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.frequencies, class: ItemsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ItemsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.frequencies</a></div> +<h1 title="Class ItemsSketch" class="title">Class ItemsSketch<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.frequencies.ItemsSketch<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item to be tracked by this sketch</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ItemsSketch<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This sketch is useful for tracking approximate frequencies of items of type <i><T></i> + with optional associated counts (<i><T></i> item, <i>long</i> count) that are members of a + multiset of such items. The true frequency of an item is defined to be the sum of associated + counts. + + <p>This implementation provides the following capabilities:</p> + <ul> + <li>Estimate the frequency of an item.</li> + <li>Return upper and lower bounds of any item, such that the true frequency is always + between the upper and lower bounds.</li> + <li>Return a global maximum error that holds for all items in the stream.</li> + <li>Return an array of frequent items that qualify either a NO_FALSE_POSITIVES or a + NO_FALSE_NEGATIVES error type.</li> + <li>Merge itself with another sketch object created from this class.</li> + <li>Serialize/Deserialize to/from a byte array.</li> + </ul> + + <p><b>Space Usage</b></p> + + <p>The sketch is initialized with a <i>maxMapSize</i> that specifies the maximum physical + length of the internal hash map of the form (<i><T></i> item, <i>long</i> count). + The <i>maxMapSize</i> must be a power of 2.</p> + + <p>The hash map starts at a very small size (8 entries), and grows as needed up to the + specified <i>maxMapSize</i>.</p> + + <p>Excluding external space required for the item objects, the internal memory space usage of + this sketch is 18 * <i>mapSize</i> bytes (assuming 8 bytes for each Java reference), plus a small + constant number of additional bytes. The internal memory space usage of this sketch will never + exceed 18 * <i>maxMapSize</i> bytes, plus a small constant number of additional bytes.</p> + + <p><b>Maximum Capacity of the Sketch</b></p> + + <p>The LOAD_FACTOR for the hash map is internally set at 75%, + which means at any time the map capacity of (item, count) pairs is <i>mapCap</i> = 0.75 * + <i>mapSize</i>. + The maximum capacity of (item, count) pairs of the sketch is <i>maxMapCap</i> = 0.75 * + <i>maxMapSize</i>.</p> + + <p><b>Updating the sketch with (item, count) pairs</b></p> + + <p>If the item is found in the hash map, the mapped count field (the "counter") is + incremented by the incoming count, otherwise, a new counter "(item, count) pair" is + created. If the number of tracked counters reaches the maximum capacity of the hash map + the sketch decrements all of the counters (by an approximately computed median), and + removes any non-positive counters.</p> + + <p><b>Accuracy</b></p> + + <p>If fewer than 0.75 * <i>maxMapSize</i> different items are inserted into the sketch the + estimated frequencies returned by the sketch will be exact.</p> + + <p>The logic of the frequent items sketch is such that the stored counts and true counts are + never too different. + More specifically, for any <i>item</i>, the sketch can return an estimate of the + true frequency of <i>item</i>, along with upper and lower bounds on the frequency + (that hold deterministically).</p> + + <p>For this implementation and for a specific active <i>item</i>, it is guaranteed that + the true frequency will be between the Upper Bound (UB) and the Lower Bound (LB) computed for + that <i>item</i>. Specifically, <i>(UB- LB) ≤ W * epsilon</i>, where <i>W</i> denotes the + sum of all item counts, and <i>epsilon = 3.5/M</i>, where <i>M</i> is the <i>maxMapSize</i>.</p> + + <p>This is a worst case guarantee that applies to arbitrary inputs.<sup>1</sup> + For inputs typically seen in practice <i>(UB-LB)</i> is usually much smaller. + </p> + + <p><b>Background</b></p> + + <p>This code implements a variant of what is commonly known as the "Misra-Gries + algorithm". Variants of it were discovered and rediscovered and redesigned several times + over the years:</p> + <ul><li>"Finding repeated elements", Misra, Gries, 1982</li> + <li>"Frequency estimation of Internet packet streams with limited space" Demaine, + Lopez-Ortiz, Munro, 2002</li> + <li>"A simple algorithm for finding frequent elements in streams and bags" Karp, Shenker, + Papadimitriou, 2003</li> + <li>"Efficient Computation of Frequent and Top-k Elements in Data Streams" Metwally, + Agrawal, Abbadi, 2006</li> + </ul> + + <sup>1</sup> For speed we do employ some randomization that introduces a small probability that + our proof of the worst-case bound might not apply to a given run. However, we have ensured + that this probability is extremely small. For example, if the stream causes one table purge + (rebuild), our proof of the worst case bound applies with probability at least 1 - 1E-14. + If the stream causes 1E9 purges, our proof applies with probability at least 1 - 1E-5.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Justin Thaler, Alexander Saydakov</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static class </code></div> +<div class="col-second even-row-color"><code><a href="ItemsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">ItemsSketch</a><wbr>(int maxMapSize)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct this sketch with the parameter maxMapSize and the default initialMapSize (8).</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getAprioriError(int,long)" class="member-name-link">getAprioriError</a><wbr>(int maxMapSize, + long estimatedTotalStreamWeight)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the estimated <i>a priori</i> error given the maxMapSize for the sketch and the + estimatedTotalStreamWeight.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentMapCapacity()" class="member-name-link">getCurrentMapCapacity</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of counters the sketch is configured to support.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEpsilon(int)" class="member-name-link">getEpsilon</a><wbr>(int maxMapSize)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns epsilon used to compute <i>a priori</i> error.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate(T)" class="member-name-link">getEstimate</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the estimate of the frequency of the given item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(long threshold, + <a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(<a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(T)" class="member-name-link">getLowerBound</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the guaranteed lower bound frequency of the given item, which can never be + negative.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaximumError()" class="member-name-link">getMaximumError</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaximumMapCapacity()" class="member-name-link">getMaximumMapCapacity</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum number of counters the sketch is configured to support.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumActiveItems()" class="member-name-link">getNumActiveItems</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStreamLength()" class="member-name-link">getStreamLength</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the sum of the frequencies in the stream seen so far by the sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(T)" class="member-name-link">getUpperBound</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the guaranteed upper bound frequency of the given item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is empty</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.frequencies.ItemsSketch)" class="member-name-link">merge</a><wbr>(<a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> other)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This function merges the other sketch into this one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to a virgin state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable summary of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ItemsSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ItemsSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this sketch with an item and a frequency count of one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T,long)" class="member-name-link">update</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item, + long count)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this sketch with an item and a positive frequency count.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int)"> +<h3>ItemsSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ItemsSketch</span><wbr><span class="parameters">(int maxMapSize)</span></div> +<div class="block">Construct this sketch with the parameter maxMapSize and the default initialMapSize (8).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxMapSize</code> - Determines the physical size of the internal hash map managed by this + sketch and must be a power of 2. The maximum capacity of this internal hash map is + 0.75 times * maxMapSize. Both the ultimate accuracy and size of this sketch are + functions of maxMapSize.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getInstance(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item that this sketch will track</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a Memory representation of a sketch of this class. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a sketch instance of this class.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getAprioriError(int,long)"> +<h3>getAprioriError</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getAprioriError</span><wbr><span class="parameters">(int maxMapSize, + long estimatedTotalStreamWeight)</span></div> +<div class="block">Returns the estimated <i>a priori</i> error given the maxMapSize for the sketch and the + estimatedTotalStreamWeight.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxMapSize</code> - the planned map size to be used when constructing this sketch.</dd> +<dd><code>estimatedTotalStreamWeight</code> - the estimated total stream weight.</dd> +<dt>Returns:</dt> +<dd>the estimated <i>a priori</i> error.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentMapCapacity()"> +<h3>getCurrentMapCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentMapCapacity</span>()</div> +<div class="block">Returns the current number of counters the sketch is configured to support.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current number of counters the sketch is configured to support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEpsilon(int)"> +<h3>getEpsilon</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getEpsilon</span><wbr><span class="parameters">(int maxMapSize)</span></div> +<div class="block">Returns epsilon used to compute <i>a priori</i> error. + This is just the value <i>3.5 / maxMapSize</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxMapSize</code> - the planned map size to be used when constructing this sketch.</dd> +<dt>Returns:</dt> +<dd>epsilon used to compute <i>a priori</i> error.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate(T)"> +<h3 id="getEstimate(java.lang.Object)">getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEstimate</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</span></div> +<div class="block">Gets the estimate of the frequency of the given item. + Note: The true frequency of a item would be the sum of the counts as a result of the + two update functions.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the given item</dd> +<dt>Returns:</dt> +<dd>the estimate of the frequency of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(T)"> +<h3 id="getLowerBound(java.lang.Object)">getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</span></div> +<div class="block">Gets the guaranteed lower bound frequency of the given item, which can never be + negative.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the given item.</dd> +<dt>Returns:</dt> +<dd>the guaranteed lower bound frequency of the given item. That is, a number which + is guaranteed to be no larger than the real frequency.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)"> +<h3>getFrequentItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</span> <span class="element-name">getFrequentItems</span><wbr><span class="parameters">(long threshold, + <a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</span></div> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition. If the threshold is lower than getMaximumError(), + then getMaximumError() will be used instead. + + <p>The method first examines all active items in the sketch (items that have a counter). + + <p>If <i>ErrorType = NO_FALSE_NEGATIVES</i>, this will include an item in the result + list if getUpperBound(item) > threshold. + There will be no false negatives, i.e., no Type II error. + There may be items in the set with true frequencies less than the threshold + (false positives).</p> + + <p>If <i>ErrorType = NO_FALSE_POSITIVES</i>, this will include an item in the result + list if getLowerBound(item) > threshold. + There will be no false positives, i.e., no Type I error. + There may be items omitted from the set with true frequencies greater than the + threshold (false negatives).</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>threshold</code> - to include items in the result list</dd> +<dd><code>errorType</code> - determines whether no false positives or no false negatives are + desired.</dd> +<dt>Returns:</dt> +<dd>an array of frequent items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFrequentItems(org.apache.datasketches.frequencies.ErrorType)"> +<h3>getFrequentItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</span> <span class="element-name">getFrequentItems</span><wbr><span class="parameters">(<a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</span></div> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold. + This is the same as getFrequentItems(getMaximumError(), errorType)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>errorType</code> - determines whether no false positives or no false negatives are + desired.</dd> +<dt>Returns:</dt> +<dd>an array of frequent items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaximumError()"> +<h3>getMaximumError</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMaximumError</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>An upper bound on the maximum error of getEstimate(item) for any item. + This is equivalent to the maximum distance between the upper bound and the lower bound + for any item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaximumMapCapacity()"> +<h3>getMaximumMapCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaximumMapCapacity</span>()</div> +<div class="block">Returns the maximum number of counters the sketch is configured to support.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum number of counters the sketch is configured to support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumActiveItems()"> +<h3>getNumActiveItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumActiveItems</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of active items in the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getStreamLength()"> +<h3>getStreamLength</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getStreamLength</span>()</div> +<div class="block">Returns the sum of the frequencies in the stream seen so far by the sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sum of the frequencies in the stream seen so far by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(T)"> +<h3 id="getUpperBound(java.lang.Object)">getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</span></div> +<div class="block">Gets the guaranteed upper bound frequency of the given item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the given item</dd> +<dt>Returns:</dt> +<dd>the guaranteed upper bound frequency of the given item. That is, a number which + is guaranteed to be no smaller than the real frequency.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if this sketch is empty</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is empty</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.frequencies.ItemsSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> other)</span></div> +<div class="block">This function merges the other sketch into this one. + The other sketch may be of a different size.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch of this class</dd> +<dt>Returns:</dt> +<dd>a sketch whose estimates are within the guarantees of the + largest error tolerance of the two merged sketches.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to a virgin state.</div> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</span></div> +<div class="block">Returns a byte array representation of this sketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human readable summary of this sketch.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>a human readable summary of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a ItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory object</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a ItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</span></div> +<div class="block">Update this sketch with an item and a frequency count of one.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - for which the frequency should be increased.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T,long)"> +<h3 id="update(java.lang.Object,long)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item, + long count)</span></div> +<div class="block">Update this sketch with an item and a positive frequency count.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - for which the frequency should be increased. The sketch uses + hashCode() and equals() methods of the type T.</dd> +<dd><code>count</code> - the amount by which the frequency of the item should be increased. + A count of zero is a no-op, and a negative count will throw an exception.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/LongsSketch.Row.html b/docs/7.0.X/org/apache/datasketches/frequencies/LongsSketch.Row.html new file mode 100644 index 000000000..5216f1590 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/LongsSketch.Row.html @@ -0,0 +1,283 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>LongsSketch.Row (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.frequencies, class: LongsSketch, class: Row"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/LongsSketch.Row.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.frequencies</a></div> +<h1 title="Class LongsSketch.Row" class="title">Class LongsSketch.Row</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.frequencies.LongsSketch.Row</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">LongsSketch.Row</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>></span></div> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compareTo(org.apache.datasketches.frequencies.LongsSketch.Row)" class="member-name-link">compareTo</a><wbr>(<a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a> that)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This equals is computed only from the Row.getEstimate() value and does not imply equality + of the other items within the row: item and upper and lower bounds.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getItem()" class="member-name-link">getItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound()" class="member-name-link">getLowerBound</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRowHeader()" class="member-name-link">getRowHeader</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound()" class="member-name-link">getUpperBound</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This hashCode is computed only from the Row.getEstimate() value.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getItem()"> +<h3>getItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getItem</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>item of type T</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEstimate</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the estimate</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound()"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getUpperBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the upper bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound()"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLowerBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>return the lower bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRowHeader()"> +<h3>getRowHeader</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getRowHeader</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the descriptive row header</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compareTo(org.apache.datasketches.frequencies.LongsSketch.Row)"> +<h3>compareTo</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">compareTo</span><wbr><span class="parameters">(<a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a> that)</span></div> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds. + Defined this way, this compareTo will be consistent with hashCode() and equals(Object).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>that</code> - the other row to compare to.</dd> +<dt>Returns:</dt> +<dd>a negative integer, zero, or a positive integer as this.getEstimate() is less than, + equal to, or greater than that.getEstimate().</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashCode()"> +<h3>hashCode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> +<div class="block">This hashCode is computed only from the Row.getEstimate() value. + Defined this way, this hashCode will be consistent with equals(Object):<br> + If (x.equals(y)) implies: x.hashCode() == y.hashCode().<br> + If (!x.equals(y)) does NOT imply: x.hashCode() != y.hashCode().</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>the hashCode computed from getEstimate().</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="equals(java.lang.Object)"> +<h3>equals</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div> +<div class="block">This equals is computed only from the Row.getEstimate() value and does not imply equality + of the other items within the row: item and upper and lower bounds. + Defined this way, this equals will be consistent with compareTo(Row).</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Parameters:</dt> +<dd><code>obj</code> - the other row to determine equality with.</dd> +<dt>Returns:</dt> +<dd>true if this.getEstimate() equals ((Row)obj).getEstimate().</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/LongsSketch.html b/docs/7.0.X/org/apache/datasketches/frequencies/LongsSketch.html new file mode 100644 index 000000000..c35fdad2f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/LongsSketch.html @@ -0,0 +1,737 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>LongsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.frequencies, class: LongsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/LongsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.frequencies</a></div> +<h1 title="Class LongsSketch" class="title">Class LongsSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.frequencies.LongsSketch</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LongsSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional + associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of + such items. The true frequency of an item is defined to be the sum of associated counts. + + <p>This implementation provides the following capabilities:</p> + <ul> + <li>Estimate the frequency of an item.</li> + <li>Return upper and lower bounds of any item, such that the true frequency is always + between the upper and lower bounds.</li> + <li>Return a global maximum error that holds for all items in the stream.</li> + <li>Return an array of frequent items that qualify either a NO_FALSE_POSITIVES or a + NO_FALSE_NEGATIVES error type.</li> + <li>Merge itself with another sketch object created from this class.</li> + <li>Serialize/Deserialize to/from a String or byte array.</li> + </ul> + + <p><b>Space Usage</b></p> + + <p>The sketch is initialized with a <i>maxMapSize</i> that specifies the maximum physical + length of the internal hash map of the form (<i>long</i> item, <i>long</i> count). + The <i>maxMapSize</i> must be a power of 2.</p> + + <p>The hash map starts at a very small size (8 entries), and grows as needed up to the + specified <i>maxMapSize</i>.</p> + + <p>At any moment the internal memory space usage of this sketch is 18 * <i>mapSize</i> bytes, + plus a small constant number of additional bytes. The maximum internal memory space usage of + this sketch will never exceed 18 * <i>maxMapSize</i> bytes, plus a small constant number of + additional bytes.</p> + + <p><b>Maximum Capacity of the Sketch</b></p> + + <p>The LOAD_FACTOR for the hash map is internally set at 75%, + which means at any time the map capacity of (item, count) pairs is <i>mapCap</i> = + 0.75 * <i>mapSize</i>. + The maximum capacity of (item, count) pairs of the sketch is <i>maxMapCap</i> = + 0.75 * <i>maxMapSize</i>.</p> + + <p><b>Updating the sketch with (item, count) pairs</b></p> + + <p>If the item is found in the hash map, the mapped count field (the "counter") is + incremented by the incoming count, otherwise, a new counter "(item, count) pair" is + created. If the number of tracked counters reaches the maximum capacity of the hash map + the sketch decrements all of the counters (by an approximately computed median), and + removes any non-positive counters.</p> + + <p><b>Accuracy</b></p> + + <p>If fewer than 0.75 * <i>maxMapSize</i> different items are inserted into the sketch the + estimated frequencies returned by the sketch will be exact.</p> + + <p>The logic of the frequent items sketch is such that the stored counts and true counts are + never too different. + More specifically, for any <i>item</i>, the sketch can return an estimate of the + true frequency of <i>item</i>, along with upper and lower bounds on the frequency + (that hold deterministically).</p> + + <p>For this implementation and for a specific active <i>item</i>, it is guaranteed that + the true frequency will be between the Upper Bound (UB) and the Lower Bound (LB) computed for + that <i>item</i>. Specifically, <i>(UB- LB) ≤ W * epsilon</i>, where <i>W</i> denotes the + sum of all item counts, and <i>epsilon = 3.5/M</i>, where <i>M</i> is the <i>maxMapSize</i>.</p> + + <p>This is a worst case guarantee that applies to arbitrary inputs.<sup>1</sup> + For inputs typically seen in practice <i>(UB-LB)</i> is usually much smaller. + </p> + + <p><b>Background</b></p> + + <p>This code implements a variant of what is commonly known as the "Misra-Gries + algorithm". Variants of it were discovered and rediscovered and redesigned several times + over the years:</p> + <ul><li>"Finding repeated elements", Misra, Gries, 1982</li> + <li>"Frequency estimation of Internet packet streams with limited space" Demaine, + Lopez-Ortiz, Munro, 2002</li> + <li>"A simple algorithm for finding frequent elements in streams and bags" Karp, Shenker, + Papadimitriou, 2003</li> + <li>"Efficient Computation of Frequent and Top-k Elements in Data Streams" Metwally, + Agrawal, Abbadi, 2006</li> + </ul> + + <sup>1</sup> For speed we do employ some randomization that introduces a small probability that + our proof of the worst-case bound might not apply to a given run. However, we have ensured + that this probability is extremely small. For example, if the stream causes one table purge + (rebuild), our proof of the worst case bound applies with probability at least 1 - 1E-14. + If the stream causes 1E9 purges, our proof applies with probability at least 1 - 1E-5.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Justin Thaler, Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static class </code></div> +<div class="col-second even-row-color"><code><a href="LongsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">LongsSketch</a><wbr>(int maxMapSize)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct this sketch with the parameter maxMapSize and the default initialMapSize (8).</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getAprioriError(int,long)" class="member-name-link">getAprioriError</a><wbr>(int maxMapSize, + long estimatedTotalStreamWeight)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the estimated <i>a priori</i> error given the maxMapSize for the sketch and the + estimatedTotalStreamWeight.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentMapCapacity()" class="member-name-link">getCurrentMapCapacity</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of counters the sketch is configured to support.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEpsilon(int)" class="member-name-link">getEpsilon</a><wbr>(int maxMapSize)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns epsilon used to compute <i>a priori</i> error.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate(long)" class="member-name-link">getEstimate</a><wbr>(long item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the estimate of the frequency of the given item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(long threshold, + <a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(<a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.String)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a sketch instance of this class from the given String, + which must be a String representation of this sketch class.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(org.apache.datasketches.memory.Memory)" class="member-name-link">getInstance</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(long)" class="member-name-link">getLowerBound</a><wbr>(long item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the guaranteed lower bound frequency of the given item, which can never be + negative.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaximumError()" class="member-name-link">getMaximumError</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaximumMapCapacity()" class="member-name-link">getMaximumMapCapacity</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum number of counters the sketch is configured to support.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumActiveItems()" class="member-name-link">getNumActiveItems</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStorageBytes()" class="member-name-link">getStorageBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of bytes required to store this sketch as an array of bytes.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStreamLength()" class="member-name-link">getStreamLength</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the sum of the frequencies (weights or counts) in the stream seen so far by the sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(long)" class="member-name-link">getUpperBound</a><wbr>(long item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the guaranteed upper bound frequency of the given item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is empty</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.frequencies.LongsSketch)" class="member-name-link">merge</a><wbr>(<a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a> other)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This function merges the other sketch into this one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to a virgin state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToString()" class="member-name-link">serializeToString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a String representation of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable summary of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a LongsSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a LongsSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this sketch with an item and a frequency count of one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long,long)" class="member-name-link">update</a><wbr>(long item, + long count)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this sketch with a item and a positive frequency count (or weight).</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int)"> +<h3>LongsSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LongsSketch</span><wbr><span class="parameters">(int maxMapSize)</span></div> +<div class="block">Construct this sketch with the parameter maxMapSize and the default initialMapSize (8).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxMapSize</code> - Determines the physical size of the internal hash map managed by this + sketch and must be a power of 2. The maximum capacity of this internal hash map is + 0.75 times * maxMapSize. Both the ultimate accuracy and size of this sketch are a + function of maxMapSize.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getInstance(org.apache.datasketches.memory.Memory)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a Memory representation of a sketch of this class. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a sketch instance of this class.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getInstance(java.lang.String)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div> +<div class="block">Returns a sketch instance of this class from the given String, + which must be a String representation of this sketch class.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>string</code> - a String representation of a sketch of this class.</dd> +<dt>Returns:</dt> +<dd>a sketch instance of this class.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getAprioriError(int,long)"> +<h3>getAprioriError</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getAprioriError</span><wbr><span class="parameters">(int maxMapSize, + long estimatedTotalStreamWeight)</span></div> +<div class="block">Returns the estimated <i>a priori</i> error given the maxMapSize for the sketch and the + estimatedTotalStreamWeight.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxMapSize</code> - the planned map size to be used when constructing this sketch.</dd> +<dd><code>estimatedTotalStreamWeight</code> - the estimated total stream weight.</dd> +<dt>Returns:</dt> +<dd>the estimated <i>a priori</i> error.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentMapCapacity()"> +<h3>getCurrentMapCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentMapCapacity</span>()</div> +<div class="block">Returns the current number of counters the sketch is configured to support.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current number of counters the sketch is configured to support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEpsilon(int)"> +<h3>getEpsilon</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getEpsilon</span><wbr><span class="parameters">(int maxMapSize)</span></div> +<div class="block">Returns epsilon used to compute <i>a priori</i> error. + This is just the value <i>3.5 / maxMapSize</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxMapSize</code> - the planned map size to be used when constructing this sketch.</dd> +<dt>Returns:</dt> +<dd>epsilon used to compute <i>a priori</i> error.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate(long)"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEstimate</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Gets the estimate of the frequency of the given item. + Note: The true frequency of a item would be the sum of the counts as a result of the + two update functions.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the given item</dd> +<dt>Returns:</dt> +<dd>the estimate of the frequency of the given item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(long)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Gets the guaranteed lower bound frequency of the given item, which can never be + negative.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the given item.</dd> +<dt>Returns:</dt> +<dd>the guaranteed lower bound frequency of the given item. That is, a number which + is guaranteed to be no larger than the real frequency.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)"> +<h3>getFrequentItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</span> <span class="element-name">getFrequentItems</span><wbr><span class="parameters">(long threshold, + <a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</span></div> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition. If the threshold is lower than getMaximumError(), + then getMaximumError() will be used instead. + + <p>The method first examines all active items in the sketch (items that have a counter). + + <p>If <i>ErrorType = NO_FALSE_NEGATIVES</i>, this will include an item in the result + list if getUpperBound(item) > threshold. + There will be no false negatives, i.e., no Type II error. + There may be items in the set with true frequencies less than the threshold + (false positives).</p> + + <p>If <i>ErrorType = NO_FALSE_POSITIVES</i>, this will include an item in the result + list if getLowerBound(item) > threshold. + There will be no false positives, i.e., no Type I error. + There may be items omitted from the set with true frequencies greater than the + threshold (false negatives). This is a subset of the NO_FALSE_NEGATIVES case.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>threshold</code> - to include items in the result list</dd> +<dd><code>errorType</code> - determines whether no false positives or no false negatives are + desired.</dd> +<dt>Returns:</dt> +<dd>an array of frequent items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFrequentItems(org.apache.datasketches.frequencies.ErrorType)"> +<h3>getFrequentItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</span> <span class="element-name">getFrequentItems</span><wbr><span class="parameters">(<a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</span></div> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold. + This is the same as getFrequentItems(getMaximumError(), errorType)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>errorType</code> - determines whether no false positives or no false negatives are + desired.</dd> +<dt>Returns:</dt> +<dd>an array of frequent items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaximumError()"> +<h3>getMaximumError</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMaximumError</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>An upper bound on the maximum error of getEstimate(item) for any item. + This is equivalent to the maximum distance between the upper bound and the lower bound + for any item.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaximumMapCapacity()"> +<h3>getMaximumMapCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaximumMapCapacity</span>()</div> +<div class="block">Returns the maximum number of counters the sketch is configured to support.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum number of counters the sketch is configured to support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumActiveItems()"> +<h3>getNumActiveItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumActiveItems</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of active items in the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getStorageBytes()"> +<h3>getStorageBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getStorageBytes</span>()</div> +<div class="block">Returns the number of bytes required to store this sketch as an array of bytes.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of bytes required to store this sketch as an array of bytes.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getStreamLength()"> +<h3>getStreamLength</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getStreamLength</span>()</div> +<div class="block">Returns the sum of the frequencies (weights or counts) in the stream seen so far by the sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sum of the frequencies in the stream seen so far by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(long)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Gets the guaranteed upper bound frequency of the given item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the given item</dd> +<dt>Returns:</dt> +<dd>the guaranteed upper bound frequency of the given item. That is, a number which + is guaranteed to be no smaller than the real frequency.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if this sketch is empty</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is empty</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.frequencies.LongsSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a> other)</span></div> +<div class="block">This function merges the other sketch into this one. + The other sketch may be of a different size.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch of this class</dd> +<dt>Returns:</dt> +<dd>a sketch whose estimates are within the guarantees of the + largest error tolerance of the two merged sketches.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to a virgin state.</div> +</section> +</li> +<li> +<section class="detail" id="serializeToString()"> +<h3>serializeToString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">serializeToString</span>()</div> +<div class="block">Returns a String representation of this sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a String representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Returns a byte array representation of this sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human readable summary of this sketch.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>a human readable summary of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a LongsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a LongsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a LongsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory object</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a LongsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Update this sketch with an item and a frequency count of one.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - for which the frequency should be increased.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long,long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long item, + long count)</span></div> +<div class="block">Update this sketch with a item and a positive frequency count (or weight).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - for which the frequency should be increased. The item can be any long value + and is only used by the sketch to determine uniqueness.</dd> +<dd><code>count</code> - the amount by which the frequency of the item should be increased. + An count of zero is a no-op, and a negative count will throw an exception.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ErrorType.html b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ErrorType.html new file mode 100644 index 000000000..39d056d7d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ErrorType.html @@ -0,0 +1,130 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.frequencies.ErrorType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.frequencies, enum: ErrorType"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.frequencies.ErrorType" class="title">Uses of Enum Class<br>org.apache.datasketches.frequencies.ErrorType</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<h2>Uses of <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> in <a href="../package-summary.html">org.apache.datasketches.frequencies</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> that return <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ErrorType.</span><code><a href="../ErrorType.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ErrorType.</span><code><a href="../ErrorType.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> with parameters of type <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(long threshold, + <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(<a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</div> +<div class="col-first even-row-color"><code><a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(long threshold, + <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(<a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ItemsSketch.Row.html b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ItemsSketch.Row.html new file mode 100644 index 000000000..e02097d58 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ItemsSketch.Row.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.frequencies.ItemsSketch.Row (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.frequencies, class: ItemsSketch, class: Row"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.frequencies.ItemsSketch.Row" class="title">Uses of Class<br>org.apache.datasketches.frequencies.ItemsSketch.Row</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<h2>Uses of <a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a> in <a href="../package-summary.html">org.apache.datasketches.frequencies</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> that return <a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(long threshold, + <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(<a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> with parameters of type <a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.Row.</span><code><a href="../ItemsSketch.Row.html#compareTo(org.apache.datasketches.frequencies.ItemsSketch.Row)" class="member-name-link">compareTo</a><wbr>(<a href="../ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="../ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>> that)</code></div> +<div class="col-last even-row-color"> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ItemsSketch.html b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ItemsSketch.html new file mode 100644 index 000000000..523f881e0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/ItemsSketch.html @@ -0,0 +1,110 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.frequencies.ItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.frequencies, class: ItemsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.frequencies.ItemsSketch" class="title">Uses of Class<br>org.apache.datasketches.frequencies.ItemsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<h2>Uses of <a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.frequencies</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> that return <a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getInstance(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#merge(org.apache.datasketches.frequencies.ItemsSketch)" class="member-name-link">merge</a><wbr>(<a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> other)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This function merges the other sketch into this one.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> with parameters of type <a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#merge(org.apache.datasketches.frequencies.ItemsSketch)" class="member-name-link">merge</a><wbr>(<a href="../ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">This function merges the other sketch into this one.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/class-use/LongsSketch.Row.html b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/LongsSketch.Row.html new file mode 100644 index 000000000..1d2bc5fa1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/LongsSketch.Row.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.frequencies.LongsSketch.Row (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.frequencies, class: LongsSketch, class: Row"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.frequencies.LongsSketch.Row" class="title">Uses of Class<br>org.apache.datasketches.frequencies.LongsSketch.Row</h1> +</div> +<div class="caption"><span>Packages that use <a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<h2>Uses of <a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a> in <a href="../package-summary.html">org.apache.datasketches.frequencies</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> that return <a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#getFrequentItems(long,org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(long threshold, + <a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given a threshold and an ErrorCondition.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#getFrequentItems(org.apache.datasketches.frequencies.ErrorType)" class="member-name-link">getFrequentItems</a><wbr>(<a href="../ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a> errorType)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array of Rows that include frequent items, estimates, upper and lower bounds + given an ErrorCondition and the default threshold.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> with parameters of type <a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketch.Row.</span><code><a href="../LongsSketch.Row.html#compareTo(org.apache.datasketches.frequencies.LongsSketch.Row)" class="member-name-link">compareTo</a><wbr>(<a href="../LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a> that)</code></div> +<div class="col-last even-row-color"> +<div class="block">This compareTo is strictly limited to the Row.getEstimate() value and does not imply any + ordering whatsoever to the other elements of the row: item and upper and lower bounds.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/class-use/LongsSketch.html b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/LongsSketch.html new file mode 100644 index 000000000..a809a3e98 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/class-use/LongsSketch.html @@ -0,0 +1,115 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.frequencies.LongsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.frequencies, class: LongsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.frequencies.LongsSketch" class="title">Uses of Class<br>org.apache.datasketches.frequencies.LongsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<h2>Uses of <a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.frequencies</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> that return <a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#getInstance(java.lang.String)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a sketch instance of this class from the given String, + which must be a String representation of this sketch class.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#getInstance(org.apache.datasketches.memory.Memory)" class="member-name-link">getInstance</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color"><code><a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#merge(org.apache.datasketches.frequencies.LongsSketch)" class="member-name-link">merge</a><wbr>(<a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">This function merges the other sketch into this one.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.frequencies</a> with parameters of type <a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketch.</span><code><a href="../LongsSketch.html#merge(org.apache.datasketches.frequencies.LongsSketch)" class="member-name-link">merge</a><wbr>(<a href="../LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">This function merges the other sketch into this one.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/package-summary.html b/docs/7.0.X/org/apache/datasketches/frequencies/package-summary.html new file mode 100644 index 000000000..ca1142e3e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/package-summary.html @@ -0,0 +1,139 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.frequencies (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.frequencies"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.frequencies" class="title">Package org.apache.datasketches.frequencies</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.frequencies</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items. + If the frequency distribution of items is sufficiently skewed, these algorithms are very + useful in identifying the "Heavy Hitters" that occurred most frequently in the stream. + The accuracy of the estimation of the frequency of an item has well understood error + bounds that can be returned by the sketch. + + <p>These algorithms are sometimes referred to as "TopN" algorithms.</p></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="ErrorType.html" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">Specifies one of two types of error regions of the statistical classification Confusion Matrix + that can be excluded from a returned sample of Frequent Items.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This sketch is useful for tracking approximate frequencies of items of type <i><T></i> + with optional associated counts (<i><T></i> item, <i>long</i> count) that are members of a + multiset of such items.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional + associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of + such items.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/package-tree.html b/docs/7.0.X/org/apache/datasketches/frequencies/package-tree.html new file mode 100644 index 000000000..2f3bbb261 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/package-tree.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.frequencies Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.frequencies"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.frequencies</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.frequencies.<a href="ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.frequencies.<a href="ItemsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><T> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>)</li> +<li class="circle">org.apache.datasketches.frequencies.<a href="LongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch</a></li> +<li class="circle">org.apache.datasketches.frequencies.<a href="LongsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>)</li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.frequencies.<a href="ErrorType.html" class="type-name-link" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/frequencies/package-use.html b/docs/7.0.X/org/apache/datasketches/frequencies/package-use.html new file mode 100644 index 000000000..336d1fd38 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/frequencies/package-use.html @@ -0,0 +1,110 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.frequencies (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.frequencies"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.frequencies" class="title">Uses of Package<br>org.apache.datasketches.frequencies</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.frequencies</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.frequencies"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.frequencies</a> used by <a href="package-summary.html">org.apache.datasketches.frequencies</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ErrorType.html#org.apache.datasketches.frequencies">ErrorType</a></div> +<div class="col-last even-row-color"> +<div class="block">Specifies one of two types of error regions of the statistical classification Confusion Matrix + that can be excluded from a returned sample of Frequent Items.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ItemsSketch.html#org.apache.datasketches.frequencies">ItemsSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This sketch is useful for tracking approximate frequencies of items of type <i><T></i> + with optional associated counts (<i><T></i> item, <i>long</i> count) that are members of a + multiset of such items.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ItemsSketch.Row.html#org.apache.datasketches.frequencies">ItemsSketch.Row</a></div> +<div class="col-last even-row-color"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/LongsSketch.html#org.apache.datasketches.frequencies">LongsSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional + associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of + such items.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/LongsSketch.Row.html#org.apache.datasketches.frequencies">LongsSketch.Row</a></div> +<div class="col-last even-row-color"> +<div class="block">Row class that defines the return values from a getFrequentItems query.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/MurmurHash3.html b/docs/7.0.X/org/apache/datasketches/hash/MurmurHash3.html new file mode 100644 index 000000000..0b10d6dc8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/MurmurHash3.html @@ -0,0 +1,433 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>MurmurHash3 (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hash, class: MurmurHash3"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/MurmurHash3.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.hash</a></div> +<h1 title="Class MurmurHash3" class="title">Class MurmurHash3</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.hash.MurmurHash3</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">MurmurHash3</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div> +<div class="block">The MurmurHash3 is a fast, non-cryptographic, 128-bit hash function that has + excellent avalanche and 2-way bit independence properties. + + <p> + Austin Appleby's C++ + <a href="https://github.com/aappleby/smhasher/blob/master/src/MurmurHash3.cpp"> + MurmurHash3_x64_128(...), final revision 150</a>, + which is in the Public Domain, was the inspiration for this implementation in Java. + </p> + + <p> + This java implementation pays close attention to the C++ algorithms in order to + maintain bit-wise compatibility, but the design is quite different. This implementation has also + been extended to include processing of arrays of longs, char or ints, which was not part of the + original C++ implementation. This implementation produces the same exact output hash bits as + the above C++ method given the same input.</p> + + <p>In addition, with this implementation, the hash of byte[], char[], int[], or long[] will + produce the same hash result if, and only if, all the arrays have the same exact length in + bytes, and if the contents of the values in the arrays have the same byte endianness and + overall order. There is a unit test for this class that demonstrates this.</p> + + <p> + The structure of this implementation also reflects a separation of code that is dependent on the + input structure (in this case byte[], int[] or long[]) from code that is independent of the input + structure. This also makes the code more readable and suitable for future extensions. + </p> + + <p>Note that even though this hash function produces 128 bits, the entropy of the resulting hash cannot + be greater than the entropy of the input. For example, if the input is only a single long of 64 bits, + the entropy of the resulting 128 bit hash is no greater than 64 bits.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../serialized-form.html#org.apache.datasketches.hash.MurmurHash3">Serialized Form</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(byte%5B%5D,int,int,long)" class="member-name-link">hash</a><wbr>(byte[] key, + int offsetBytes, + int lengthBytes, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a portion of the given byte[] array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(byte%5B%5D,long)" class="member-name-link">hash</a><wbr>(byte[] key, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash the given byte[] array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(char%5B%5D,int,int,long)" class="member-name-link">hash</a><wbr>(char[] key, + int offsetChars, + int lengthChars, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a portion of the given char[] array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(char%5B%5D,long)" class="member-name-link">hash</a><wbr>(char[] key, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash the given char[] array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(int%5B%5D,int,int,long)" class="member-name-link">hash</a><wbr>(int[] key, + int offsetInts, + int lengthInts, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a portion of the given int[] array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(int%5B%5D,long)" class="member-name-link">hash</a><wbr>(int[] key, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash the given int[] array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(long%5B%5D,int,int,long)" class="member-name-link">hash</a><wbr>(long[] key, + int offsetLongs, + int lengthLongs, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a portion of the given long[] array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(long%5B%5D,long)" class="member-name-link">hash</a><wbr>(long[] key, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash the given long[] array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(long,long)" class="member-name-link">hash</a><wbr>(long key, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash the given long.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(java.nio.ByteBuffer,long)" class="member-name-link">hash</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash the remaining bytes of the given ByteBuffer starting at position().</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(org.apache.datasketches.memory.Memory,long)" class="member-name-link">hash</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash the given Memory.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="hash(long,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(long key, + long seed)</span></div> +<div class="block">Hash the given long.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input long.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(long[],long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(long[] key, + long seed)</span></div> +<div class="block">Hash the given long[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input long[] array. It must be non-null and non-empty.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(long[],int,int,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(long[] key, + int offsetLongs, + int lengthLongs, + long seed)</span></div> +<div class="block">Hash a portion of the given long[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input long[] array. It must be non-null and non-empty.</dd> +<dd><code>offsetLongs</code> - the starting offset in longs.</dd> +<dd><code>lengthLongs</code> - the length in longs of the portion of the array to be hashed.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(int[],long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(int[] key, + long seed)</span></div> +<div class="block">Hash the given int[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input int[] array. It must be non-null and non-empty.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(int[],int,int,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(int[] key, + int offsetInts, + int lengthInts, + long seed)</span></div> +<div class="block">Hash a portion of the given int[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input int[] array. It must be non-null and non-empty.</dd> +<dd><code>offsetInts</code> - the starting offset in ints.</dd> +<dd><code>lengthInts</code> - the length in ints of the portion of the array to be hashed.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(char[],long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(char[] key, + long seed)</span></div> +<div class="block">Hash the given char[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input char[] array. It must be non-null and non-empty.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(char[],int,int,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(char[] key, + int offsetChars, + int lengthChars, + long seed)</span></div> +<div class="block">Hash a portion of the given char[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input char[] array. It must be non-null and non-empty.</dd> +<dd><code>offsetChars</code> - the starting offset in chars.</dd> +<dd><code>lengthChars</code> - the length in chars of the portion of the array to be hashed.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(byte[],long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(byte[] key, + long seed)</span></div> +<div class="block">Hash the given byte[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input byte[] array. It must be non-null and non-empty.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(byte[],int,int,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(byte[] key, + int offsetBytes, + int lengthBytes, + long seed)</span></div> +<div class="block">Hash a portion of the given byte[] array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The input byte[] array. It must be non-null and non-empty.</dd> +<dd><code>offsetBytes</code> - the starting offset in bytes.</dd> +<dd><code>lengthBytes</code> - the length in bytes of the portion of the array to be hashed.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(java.nio.ByteBuffer,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf, + long seed)</span></div> +<div class="block">Hash the remaining bytes of the given ByteBuffer starting at position().</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>buf</code> - The input ByteBuffer. It must be non-null and non-empty.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(org.apache.datasketches.memory.Memory,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hash</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long seed)</span></div> +<div class="block">Hash the given Memory. + + <p>Note: if you want to hash only a portion of Memory, convert it to the + appropriate Region first with ByteOrder = Little Endian. If it is not + Little Endian a new region view will be created as Little Endian. + This does not change the underlying data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - The input Memory. It must be non-null and non-empty.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>a 128-bit hash of the input as a long array of size 2.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/MurmurHash3Adaptor.html b/docs/7.0.X/org/apache/datasketches/hash/MurmurHash3Adaptor.html new file mode 100644 index 000000000..abcb95463 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/MurmurHash3Adaptor.html @@ -0,0 +1,645 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>MurmurHash3Adaptor (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hash, class: MurmurHash3Adaptor"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/MurmurHash3Adaptor.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.hash</a></div> +<h1 title="Class MurmurHash3Adaptor" class="title">Class MurmurHash3Adaptor</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.hash.MurmurHash3Adaptor</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">MurmurHash3Adaptor</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A general purpose wrapper for the MurmurHash3. + <ul> + <li>Inputs can be long, long[], int[], char[], byte[], double or String.</li> + <li>Returns null if arrays or String is null or empty.</li> + <li>Provides methods for returning the 128-bit result as either an array of 2 longs or as a byte + array of 16 bytes.</li> + <li>Provides modulo, asDouble and asInt functions.</li> + </ul></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#asDouble(long%5B%5D)" class="member-name-link">asDouble</a><wbr>(long[] hash)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a uniform random double with a minimum inclusive value of zero and a maximum exclusive + value of 1.0.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#asInt(byte%5B%5D,int)" class="member-name-link">asInt</a><wbr>(byte[] data, + int n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#asInt(double,int)" class="member-name-link">asInt</a><wbr>(double datum, + int n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input double.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#asInt(int%5B%5D,int)" class="member-name-link">asInt</a><wbr>(int[] data, + int n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#asInt(long%5B%5D,int)" class="member-name-link">asInt</a><wbr>(long[] data, + int n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#asInt(long,int)" class="member-name-link">asInt</a><wbr>(long datum, + int n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input datum.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#asInt(java.lang.String,int)" class="member-name-link">asInt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum, + int n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input datum.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToBytes(byte%5B%5D,long)" class="member-name-link">hashToBytes</a><wbr>(byte[] data, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a byte[] and long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToBytes(char%5B%5D,long)" class="member-name-link">hashToBytes</a><wbr>(char[] data, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a char[] and long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToBytes(double,long)" class="member-name-link">hashToBytes</a><wbr>(double datum, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a double and long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToBytes(int%5B%5D,long)" class="member-name-link">hashToBytes</a><wbr>(int[] data, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash an int[] and long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToBytes(long%5B%5D,long)" class="member-name-link">hashToBytes</a><wbr>(long[] data, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a long[] and long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToBytes(long,long)" class="member-name-link">hashToBytes</a><wbr>(long datum, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a long and long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToBytes(java.lang.String,long)" class="member-name-link">hashToBytes</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a String and long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToLongs(byte%5B%5D,long)" class="member-name-link">hashToLongs</a><wbr>(byte[] data, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a byte[] and long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToLongs(char%5B%5D,long)" class="member-name-link">hashToLongs</a><wbr>(char[] data, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a char[] and long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToLongs(double,long)" class="member-name-link">hashToLongs</a><wbr>(double datum, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a double and long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToLongs(int%5B%5D,long)" class="member-name-link">hashToLongs</a><wbr>(int[] data, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a int[] and long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToLongs(long%5B%5D,long)" class="member-name-link">hashToLongs</a><wbr>(long[] data, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a long[] and long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToLongs(long,long)" class="member-name-link">hashToLongs</a><wbr>(long datum, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a long and long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashToLongs(java.lang.String,long)" class="member-name-link">hashToLongs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Hash a String and long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#modulo(long%5B%5D,int)" class="member-name-link">modulo</a><wbr>(long[] hash, + int divisor)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the remainder from the modulo division of the 128-bit output of the murmurHash3 by the + divisor.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#modulo(long,long,int)" class="member-name-link">modulo</a><wbr>(long h0, + long h1, + int divisor)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the remainder from the modulo division of the 128-bit output of the murmurHash3 by the + divisor.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="hashToBytes(long,long)"> +<h3>hashToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">hashToBytes</span><wbr><span class="parameters">(long datum, + long seed)</span></div> +<div class="block">Hash a long and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the input long value</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a byte[16] in Big Endian order from 2 64-bit longs.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToBytes(long[],long)"> +<h3>hashToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">hashToBytes</span><wbr><span class="parameters">(long[] data, + long seed)</span></div> +<div class="block">Hash a long[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input long array</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a byte[16] in Big Endian order from 2 64-bit longs.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToBytes(int[],long)"> +<h3>hashToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">hashToBytes</span><wbr><span class="parameters">(int[] data, + long seed)</span></div> +<div class="block">Hash an int[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input int array</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a byte[16] in Big Endian order from 2 64-bit longs.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToBytes(char[],long)"> +<h3>hashToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">hashToBytes</span><wbr><span class="parameters">(char[] data, + long seed)</span></div> +<div class="block">Hash a char[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input char array</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a byte[16] in Big Endian order from 2 64-bit longs.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToBytes(byte[],long)"> +<h3>hashToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">hashToBytes</span><wbr><span class="parameters">(byte[] data, + long seed)</span></div> +<div class="block">Hash a byte[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input byte array</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a byte[16] in Big Endian order from 2 64-bit longs.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToBytes(double,long)"> +<h3>hashToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">hashToBytes</span><wbr><span class="parameters">(double datum, + long seed)</span></div> +<div class="block">Hash a double and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the input double</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a byte[16] in Big Endian order from 2 64-bit longs.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToBytes(java.lang.String,long)"> +<h3>hashToBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name">hashToBytes</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum, + long seed)</span></div> +<div class="block">Hash a String and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the input String</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a byte[16] in Big Endian order from 2 64-bit longs.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToLongs(long,long)"> +<h3>hashToLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hashToLongs</span><wbr><span class="parameters">(long datum, + long seed)</span></div> +<div class="block">Hash a long and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the input long</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a long[2].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToLongs(long[],long)"> +<h3>hashToLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hashToLongs</span><wbr><span class="parameters">(long[] data, + long seed)</span></div> +<div class="block">Hash a long[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input long array.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a long[2].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToLongs(int[],long)"> +<h3>hashToLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hashToLongs</span><wbr><span class="parameters">(int[] data, + long seed)</span></div> +<div class="block">Hash a int[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input int array.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a long[2].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToLongs(char[],long)"> +<h3>hashToLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hashToLongs</span><wbr><span class="parameters">(char[] data, + long seed)</span></div> +<div class="block">Hash a char[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input char array.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a long[2].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToLongs(byte[],long)"> +<h3>hashToLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hashToLongs</span><wbr><span class="parameters">(byte[] data, + long seed)</span></div> +<div class="block">Hash a byte[] and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input byte array.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a long[2].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToLongs(double,long)"> +<h3>hashToLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hashToLongs</span><wbr><span class="parameters">(double datum, + long seed)</span></div> +<div class="block">Hash a double and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the input double.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a long[2].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashToLongs(java.lang.String,long)"> +<h3>hashToLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">hashToLongs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum, + long seed)</span></div> +<div class="block">Hash a String and long seed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the input String.</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>The 128-bit hash as a long[2].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="asInt(long[],int)"> +<h3>asInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">asInt</span><wbr><span class="parameters">(long[] data, + int n)</span></div> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input long array.</dd> +<dd><code>n</code> - The upper exclusive bound of the integers produced. Must be > 1.</dd> +<dt>Returns:</dt> +<dd>deterministic uniform random integer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="asInt(int[],int)"> +<h3>asInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">asInt</span><wbr><span class="parameters">(int[] data, + int n)</span></div> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input int array.</dd> +<dd><code>n</code> - The upper exclusive bound of the integers produced. Must be > 1.</dd> +<dt>Returns:</dt> +<dd>deterministic uniform random integer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="asInt(byte[],int)"> +<h3>asInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">asInt</span><wbr><span class="parameters">(byte[] data, + int n)</span></div> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - the input byte array.</dd> +<dd><code>n</code> - The upper exclusive bound of the integers produced. Must be > 1.</dd> +<dt>Returns:</dt> +<dd>deterministic uniform random integer.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="asInt(long,int)"> +<h3>asInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">asInt</span><wbr><span class="parameters">(long datum, + int n)</span></div> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input datum.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the input long</dd> +<dd><code>n</code> - The upper exclusive bound of the integers produced. Must be > 1.</dd> +<dt>Returns:</dt> +<dd>deterministic uniform random integer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="asInt(double,int)"> +<h3>asInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">asInt</span><wbr><span class="parameters">(double datum, + int n)</span></div> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input double.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the given double.</dd> +<dd><code>n</code> - The upper exclusive bound of the integers produced. Must be > 1.</dd> +<dt>Returns:</dt> +<dd>deterministic uniform random integer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="asInt(java.lang.String,int)"> +<h3>asInt</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">asInt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum, + int n)</span></div> +<div class="block">Returns a deterministic uniform random integer between zero (inclusive) and + n (exclusive) given the input datum.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - the given String.</dd> +<dd><code>n</code> - The upper exclusive bound of the integers produced. Must be > 1.</dd> +<dt>Returns:</dt> +<dd>deterministic uniform random integer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="asDouble(long[])"> +<h3>asDouble</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">asDouble</span><wbr><span class="parameters">(long[] hash)</span></div> +<div class="block">Returns a uniform random double with a minimum inclusive value of zero and a maximum exclusive + value of 1.0. + + <p>The double values produced are only as random as the MurmurHash3 algorithm, which may be + adequate for many applications. However, if you are looking for high guarantees of randomness + you should turn to more sophisticated random generators such as Mersenne Twister or Well + algorithms.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hash</code> - The output of the MurmurHash3.</dd> +<dt>Returns:</dt> +<dd>the uniform random double.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="modulo(long,long,int)"> +<h3>modulo</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">modulo</span><wbr><span class="parameters">(long h0, + long h1, + int divisor)</span></div> +<div class="block">Returns the remainder from the modulo division of the 128-bit output of the murmurHash3 by the + divisor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>h0</code> - The lower 64-bits of the 128-bit MurmurHash3 hash.</dd> +<dd><code>h1</code> - The upper 64-bits of the 128-bit MurmurHash3 hash.</dd> +<dd><code>divisor</code> - Must be positive and greater than zero.</dd> +<dt>Returns:</dt> +<dd>the modulo result.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="modulo(long[],int)"> +<h3>modulo</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">modulo</span><wbr><span class="parameters">(long[] hash, + int divisor)</span></div> +<div class="block">Returns the remainder from the modulo division of the 128-bit output of the murmurHash3 by the + divisor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hash</code> - The size 2 long array from the MurmurHash3.</dd> +<dd><code>divisor</code> - Must be positive and greater than zero.</dd> +<dt>Returns:</dt> +<dd>the modulo result</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/XxHash.html b/docs/7.0.X/org/apache/datasketches/hash/XxHash.html new file mode 100644 index 000000000..ec08b41e6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/XxHash.html @@ -0,0 +1,212 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>XxHash (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hash, class: XxHash"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/XxHash.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.hash</a></div> +<h1 title="Class XxHash" class="title">Class XxHash</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.hash.XxHash</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">XxHash</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The XxHash is a fast, non-cryptographic, 64-bit hash function that has + excellent avalanche and 2-way bit independence properties. + + <p>This class wraps the + <a href="https://github.com/apache/datasketches-memory/blob/master/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/XxHash.java">Memory Component XxHash</a> + implementation.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">XxHash</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(long,long)" class="member-name-link">hash</a><wbr>(long in, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a 64-bit hash.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hash(org.apache.datasketches.memory.Memory,long,long,long)" class="member-name-link">hash</a><wbr>(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + long lengthBytes, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Compute the hash of the given Memory object.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>XxHash</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XxHash</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="hash(org.apache.datasketches.memory.Memory,long,long,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">hash</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long offsetBytes, + long lengthBytes, + long seed)</span></div> +<div class="block">Compute the hash of the given Memory object.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - The given Memory object</dd> +<dd><code>offsetBytes</code> - Starting at this offset in bytes</dd> +<dd><code>lengthBytes</code> - Continuing for this number of bytes</dd> +<dd><code>seed</code> - use this seed for the hash function</dd> +<dt>Returns:</dt> +<dd>return the resulting 64-bit hash value.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hash(long,long)"> +<h3>hash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">hash</span><wbr><span class="parameters">(long in, + long seed)</span></div> +<div class="block">Returns a 64-bit hash.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>in</code> - a long</dd> +<dd><code>seed</code> - A long valued seed.</dd> +<dt>Returns:</dt> +<dd>the hash</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/class-use/MurmurHash3.html b/docs/7.0.X/org/apache/datasketches/hash/class-use/MurmurHash3.html new file mode 100644 index 000000000..15e37efa6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/class-use/MurmurHash3.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.hash.MurmurHash3 (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hash, class: MurmurHash3"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../MurmurHash3.html" title="class in org.apache.datasketches.hash">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.hash.MurmurHash3" class="title">Uses of Class<br>org.apache.datasketches.hash.MurmurHash3</h1> +</div> +No usage of org.apache.datasketches.hash.MurmurHash3</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/class-use/MurmurHash3Adaptor.html b/docs/7.0.X/org/apache/datasketches/hash/class-use/MurmurHash3Adaptor.html new file mode 100644 index 000000000..488cf20a4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/class-use/MurmurHash3Adaptor.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.hash.MurmurHash3Adaptor (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hash, class: MurmurHash3Adaptor"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.hash.MurmurHash3Adaptor" class="title">Uses of Class<br>org.apache.datasketches.hash.MurmurHash3Adaptor</h1> +</div> +No usage of org.apache.datasketches.hash.MurmurHash3Adaptor</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/class-use/XxHash.html b/docs/7.0.X/org/apache/datasketches/hash/class-use/XxHash.html new file mode 100644 index 000000000..a6ff8c4fb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/class-use/XxHash.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.hash.XxHash (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hash, class: XxHash"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../XxHash.html" title="class in org.apache.datasketches.hash">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.hash.XxHash" class="title">Uses of Class<br>org.apache.datasketches.hash.XxHash</h1> +</div> +No usage of org.apache.datasketches.hash.XxHash</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/package-summary.html b/docs/7.0.X/org/apache/datasketches/hash/package-summary.html new file mode 100644 index 000000000..fc2a97cfa --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/package-summary.html @@ -0,0 +1,120 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.hash (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hash"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.hash" class="title">Package org.apache.datasketches.hash</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.hash</span></div> +<section class="package-description" id="package-description"> +<div class="block">The hash package contains a high-performing and extended Java implementations + of Austin Appleby's 128-bit MurmurHash3 hash function originally coded in C. + This core MurmurHash3.java class is used throughout many of the sketch classes for consistency + and as long as the user specifies the same seed will result in coordinated hash operations. + This package also contains an adaptor class that extends the basic class with more functions + commonly associated with hashing.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The MurmurHash3 is a fast, non-cryptographic, 128-bit hash function that has + excellent avalanche and 2-way bit independence properties.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">A general purpose wrapper for the MurmurHash3.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="XxHash.html" title="class in org.apache.datasketches.hash">XxHash</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The XxHash is a fast, non-cryptographic, 64-bit hash function that has + excellent avalanche and 2-way bit independence properties.</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/package-tree.html b/docs/7.0.X/org/apache/datasketches/hash/package-tree.html new file mode 100644 index 000000000..14742b02c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/package-tree.html @@ -0,0 +1,78 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.hash Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.hash"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.hash</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.hash.<a href="MurmurHash3.html" class="type-name-link" title="class in org.apache.datasketches.hash">MurmurHash3</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)</li> +<li class="circle">org.apache.datasketches.hash.<a href="MurmurHash3Adaptor.html" class="type-name-link" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></li> +<li class="circle">org.apache.datasketches.hash.<a href="XxHash.html" class="type-name-link" title="class in org.apache.datasketches.hash">XxHash</a></li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hash/package-use.html b/docs/7.0.X/org/apache/datasketches/hash/package-use.html new file mode 100644 index 000000000..81ae97dd3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hash/package-use.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.hash (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hash"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.hash" class="title">Uses of Package<br>org.apache.datasketches.hash</h1> +</div> +No usage of org.apache.datasketches.hash</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/HllSketch.html b/docs/7.0.X/org/apache/datasketches/hll/HllSketch.html new file mode 100644 index 000000000..e3fa42132 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/HllSketch.html @@ -0,0 +1,1145 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>HllSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hll, class: HllSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/HllSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.hll</a></div> +<h1 title="Class HllSketch" class="title">Class HllSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.hll.HllSketch</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">HllSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The HllSketch is actually a collection of compact implementations of Phillipe Flajolet’s HyperLogLog (HLL) + sketch but with significantly improved error behavior and excellent speed performance. + + <p>If the use case for sketching is primarily counting uniques and merging, the HLL sketch is the 2nd highest + performing in terms of accuracy for storage space consumed in the DataSketches library + (the new CPC sketch developed by Kevin J. Lang now beats HLL in terms of accuracy / space). + For large counts, HLL sketches can be 2 to 8 times smaller for the same accuracy than the DataSketches Theta + Sketches when serialized, but the Theta sketches can do set intersections and differences while HLL and CPC cannot. + The CPC sketch and HLL share similar use cases, but the CPC sketch is about 30 to 40% smaller than the HLL sketch + when serialized and larger than the HLL when active in memory. Choose your weapons!</p> + + <p>A new HLL sketch is created with a simple constructor:</p> + <pre><code> + int lgK = 12; //This is log-base2 of k, so k = 4096. lgK can be from 4 to 21 + HllSketch sketch = new HllSketch(lgK); //TgtHllType.HLL_4 is the default + //OR + HllSketch sketch = new HllSketch(lgK, TgtHllType.HLL_6); + //OR + HllSketch sketch = new HllSketch(lgK, TgtHllType.HLL_8); + </code></pre> + + <p>All three different sketch types are targets in that the sketches start out in a warm-up mode that is small in + size and gradually grows as needed until the full HLL array is allocated. The HLL_4, HLL_6 and HLL_8 represent + different levels of compression of the final HLL array where the 4, 6 and 8 refer to the number of bits each + bucket of the HLL array is compressed down to. + The HLL_4 is the most compressed but generally slower than the other two, especially during union operations.</p> + + <p>All three types share the same API. Updating the HllSketch is very simple:</p> + + <pre><code> + long n = 1000000; + for (int i = 0; i < n; i++) { + sketch.update(i); + } + </code></pre> + + <p>Each of the presented integers above are first hashed into 128-bit hash values that are used by the sketch + HLL algorithm, so the above loop is essentially equivalent to using a random number generator initialized with a + seed so that the sequence is deterministic and random.</p> + + <p>Obtaining the cardinality results from the sketch is also simple:</p> + + <pre><code> + double estimate = sketch.getEstimate(); + double estUB = sketch.getUpperBound(1.0); //the upper bound at 1 standard deviation. + double estLB = sketch.getLowerBound(1.0); //the lower bound at 1 standard deviation. + //OR + System.out.println(sketch.toString()); //will output a summary of the sketch. + </code></pre> + + <p>Which produces a console output something like this:</p> + + <pre><code> + ### HLL SKETCH SUMMARY: + Log Config K : 12 + Hll Target : HLL_4 + Current Mode : HLL + LB : 977348.7024560181 + Estimate : 990116.6007366662 + UB : 1003222.5095308956 + OutOfOrder Flag: false + CurMin : 5 + NumAtCurMin : 1 + HipAccum : 990116.6007366662 + </code></pre></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second even-row-color"><code><a href="#DEFAULT_HLL_TYPE" class="member-name-link">DEFAULT_HLL_TYPE</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The default HLL-TYPE is HLL_4</div> +</div> +<div class="col-first odd-row-color"><code>static final int</code></div> +<div class="col-second odd-row-color"><code><a href="#DEFAULT_LG_K" class="member-name-link">DEFAULT_LG_K</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The default Log_base2 of K</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">HllSketch</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new on-heap sketch with the default lgConfigK and tgtHllType.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">HllSketch</a><wbr>(int lgConfigK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a new on-heap sketch with the default tgtHllType.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType)" class="member-name-link">HllSketch</a><wbr>(int lgConfigK, + <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new on-heap sketch with the type of HLL sketch to configure.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">HllSketch</a><wbr>(int lgConfigK, + <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a new sketch with the type of HLL sketch to configure and the given + WritableMemory as the destination for the sketch.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return a copy of this sketch onto the Java heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyAs(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">copyAs</a><wbr>(<a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return a deep copy of this sketch onto the Java heap with the specified TgtHllType.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompactSerializationBytes()" class="member-name-link">getCompactSerializationBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toCompactByteArray()</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompositeEstimate()" class="member-name-link">getCompositeEstimate</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is less accurate than the <i>getEstimate()</i> method and is automatically used + when the sketch has gone through union operations where the more accurate HIP estimator + cannot be used.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return the cardinality estimate</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgConfigK()" class="member-name-link">getLgConfigK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the <i>lgConfigK</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int)" class="member-name-link">getLowerBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)" class="member-name-link">getMaxUpdatableSerializationBytes</a><wbr>(int lgConfigK, + <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum size in bytes that this sketch can grow to given lgConfigK.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRelErr(boolean,boolean,int,int)" class="member-name-link">getRelErr</a><wbr>(boolean upperBound, + boolean oooFlag, + int lgConfigK, + int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the current (approximate) Relative Error (RE) asymptotic values given several + parameters.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializationVersion()" class="member-name-link">getSerializationVersion</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the current serialization version.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializationVersion(org.apache.datasketches.memory.Memory)" class="member-name-link">getSerializationVersion</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the current serialization version of the given Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTgtHllType()" class="member-name-link">getTgtHllType</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpdatableSerializationBytes()" class="member-name-link">getUpdatableSerializationBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toUpdatableByteArray()</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int)" class="member-name-link">getUpperBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(byte%5B%5D)" class="member-name-link">heapify</a><wbr>(byte[] byteArray)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given byte array, which must be a valid HllSketch image and may have data.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory, which must be a valid HllSketch image and may have data.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCompact()" class="member-name-link">isCompact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the backing memory of this sketch is in compact form.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if empty</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This HLL family of sketches and operators is always estimating, even for very small values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMemory()" class="member-name-link">isMemory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch was created using Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isOffHeap()" class="member-name-link">isOffHeap</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the backing memory for this sketch is off-heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the given Memory refers to the same underlying resource as this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets to empty, but does not change the configured values of lgConfigK and tgtHllType.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toCompactByteArray()" class="member-name-link">toCompactByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serializes this sketch as a byte array in compact form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human readable summary as a string.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean summary, + boolean detail, + boolean auxDetail)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human readable summary with optional detail.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean,boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean summary, + boolean detail, + boolean auxDetail, + boolean all)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human readable summary with optional detail</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of an HllSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of an HllSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toUpdatableByteArray()" class="member-name-link">toUpdatableByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serializes this sketch as a byte array in an updatable form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given byte array as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(char%5B%5D)" class="member-name-link">update</a><wbr>(char[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given char array as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given double (or float) datum as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(int%5B%5D)" class="member-name-link">update</a><wbr>(int[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given integer array as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given long as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D)" class="member-name-link">update</a><wbr>(long[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given long array as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given String as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.nio.ByteBuffer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given byte buffer as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wraps the given read-only Memory that must be a image of a valid sketch, + which may be in compact or updatable form, and should have data.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcWmem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable sketch, + and may have data.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DEFAULT_LG_K"> +<h3>DEFAULT_LG_K</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_LG_K</span></div> +<div class="block">The default Log_base2 of K</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.hll.HllSketch.DEFAULT_LG_K">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="DEFAULT_HLL_TYPE"> +<h3>DEFAULT_HLL_TYPE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">DEFAULT_HLL_TYPE</span></div> +<div class="block">The default HLL-TYPE is HLL_4</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>HllSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">HllSketch</span>()</div> +<div class="block">Constructs a new on-heap sketch with the default lgConfigK and tgtHllType.</div> +</section> +</li> +<li> +<section class="detail" id="<init>(int)"> +<h3>HllSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">HllSketch</span><wbr><span class="parameters">(int lgConfigK)</span></div> +<div class="block">Constructs a new on-heap sketch with the default tgtHllType.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgConfigK</code> - The Log2 of K for the target HLL sketch. This value must be + between 4 and 21 inclusively.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,org.apache.datasketches.hll.TgtHllType)"> +<h3>HllSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">HllSketch</span><wbr><span class="parameters">(int lgConfigK, + <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</span></div> +<div class="block">Constructs a new on-heap sketch with the type of HLL sketch to configure.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgConfigK</code> - The Log2 of K for the target HLL sketch. This value must be + between 4 and 21 inclusively.</dd> +<dd><code>tgtHllType</code> - the desired HLL type.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,org.apache.datasketches.hll.TgtHllType,org.apache.datasketches.memory.WritableMemory)"> +<h3>HllSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">HllSketch</span><wbr><span class="parameters">(int lgConfigK, + <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Constructs a new sketch with the type of HLL sketch to configure and the given + WritableMemory as the destination for the sketch. This WritableMemory is usually configured + for off-heap memory. What remains on the java heap is a thin wrapper object that reads and + writes to the given WritableMemory. + + <p>The given <i>dstMem</i> is checked for the required capacity as determined by + <a href="#getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)"><code>getMaxUpdatableSerializationBytes(int, TgtHllType)</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgConfigK</code> - The Log2 of K for the target HLL sketch. This value must be + between 4 and 21 inclusively.</dd> +<dd><code>tgtHllType</code> - the desired HLL type.</dd> +<dd><code>dstMem</code> - the destination memory for the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(byte[])"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(byte[] byteArray)</span></div> +<div class="block">Heapify the given byte array, which must be a valid HllSketch image and may have data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArray</code> - the given byte array. This byteArray is not modified and is not retained + by the on-heap sketch.</dd> +<dt>Returns:</dt> +<dd>an HllSketch on the java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify the given Memory, which must be a valid HllSketch image and may have data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given Memory, which is read-only.</dd> +<dt>Returns:</dt> +<dd>an HllSketch on the java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="writableWrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>writableWrap</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">writableWrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcWmem)</span></div> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable sketch, + and may have data. What remains on the java heap is a + thin wrapper object that reads and writes to the given WritableMemory, which, depending on + how the user configures the WritableMemory, may actually reside on the Java heap or off-heap. + + <p>The given <i>dstMem</i> is checked for the required capacity as determined by + <a href="#getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)"><code>getMaxUpdatableSerializationBytes(int, TgtHllType)</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcWmem</code> - an writable image of a valid source sketch with data.</dd> +<dt>Returns:</dt> +<dd>an HllSketch where the sketch data is in the given dstMem.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wraps the given read-only Memory that must be a image of a valid sketch, + which may be in compact or updatable form, and should have data. Any attempt to update the + given source Memory will throw an exception.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a read-only image of a valid source sketch.</dd> +<dt>Returns:</dt> +<dd>an HllSketch, where the read-only data of the sketch is in the given srcMem.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">copy</span>()</div> +<div class="block">Return a copy of this sketch onto the Java heap.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a copy of this sketch onto the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copyAs(org.apache.datasketches.hll.TgtHllType)"> +<h3>copyAs</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">copyAs</span><wbr><span class="parameters">(<a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</span></div> +<div class="block">Return a deep copy of this sketch onto the Java heap with the specified TgtHllType.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tgtHllType</code> - the TgtHllType enum</dd> +<dt>Returns:</dt> +<dd>a deep copy of this sketch with the specified TgtHllType.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompositeEstimate()"> +<h3>getCompositeEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getCompositeEstimate</span>()</div> +<div class="block">This is less accurate than the <i>getEstimate()</i> method and is automatically used + when the sketch has gone through union operations where the more accurate HIP estimator + cannot be used. + This is made public only for error characterization software that exists in separate + packages and is not intended for normal use.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the composite estimate</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<div class="block">Return the cardinality estimate</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the cardinality estimate</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgConfigK()"> +<h3>getLgConfigK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgConfigK</span>()</div> +<div class="block">Gets the <i>lgConfigK</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the <i>lgConfigK</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactSerializationBytes()"> +<h3>getCompactSerializationBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCompactSerializationBytes</span>()</div> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toCompactByteArray()</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the size in bytes of the current sketch when serialized using + <i>toCompactByteArray()</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - This must be an integer between 1 and 3, inclusive. + <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the lower bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)"> +<h3>getMaxUpdatableSerializationBytes</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">getMaxUpdatableSerializationBytes</span><wbr><span class="parameters">(int lgConfigK, + <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</span></div> +<div class="block">Returns the maximum size in bytes that this sketch can grow to given lgConfigK. + However, for the HLL_4 sketch type, this value can be exceeded in extremely rare cases. + If exceeded, it will be larger by only a few percent.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgConfigK</code> - The Log2 of K for the target HLL sketch. This value must be + between 4 and 21 inclusively.</dd> +<dd><code>tgtHllType</code> - the desired Hll type</dd> +<dt>Returns:</dt> +<dd>the maximum size in bytes that this sketch can grow to.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getTgtHllType()"> +<h3>getTgtHllType</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">getTgtHllType</span>()</div> +<div class="block">Gets the <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the TgtHllType enum value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpdatableSerializationBytes()"> +<h3>getUpdatableSerializationBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getUpdatableSerializationBytes</span>()</div> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toUpdatableByteArray()</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the size in bytes of the current sketch when serialized using + <i>toUpdatableByteArray()</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - This must be an integer between 1 and 3, inclusive. + <a href="../../../../resources/dictionary.html#numStdDev">Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the upper bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isCompact()"> +<h3>isCompact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCompact</span>()</div> +<div class="block">Returns true if the backing memory of this sketch is in compact form.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the backing memory of this sketch is in compact form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if empty</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if empty</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isMemory()"> +<h3>isMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMemory</span>()</div> +<div class="block">Returns true if this sketch was created using Memory.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch was created using Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isOffHeap()"> +<h3>isOffHeap</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOffHeap</span>()</div> +<div class="block">Returns true if the backing memory for this sketch is off-heap.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the backing memory for this sketch is off-heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isSameResource(org.apache.datasketches.memory.Memory)"> +<h3>isSameResource</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSameResource</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns true if the given Memory refers to the same underlying resource as this sketch. + The capacities must be the same. If <i>this</i> is a region, + the region offset must also be the same. + + <p>This is only relevant for HLL_4 sketches that have been configured for off-heap + using WritableMemory or Memory. For on-heap sketches or unions this will return false. + + <p>It is rare, but possible, the the off-heap memory that has been allocated to an HLL_4 + sketch may not be large enough. If this should happen, the sketch makes a request for more + memory from the owner of the resource and then moves itself to this new location. This all + happens transparently to the user. This method provides a means for the user to + inquire of the sketch if it has, in fact, moved itself.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>true if the given Memory refers to the same underlying resource as this sketch or + union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets to empty, but does not change the configured values of lgConfigK and tgtHllType.</div> +</section> +</li> +<li> +<section class="detail" id="toCompactByteArray()"> +<h3>toCompactByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toCompactByteArray</span>()</div> +<div class="block">Serializes this sketch as a byte array in compact form. The compact form is smaller in size + than the updatable form and read-only. It can be used in union operations as follows: + <pre><code> + Union union; HllSketch sk, sk2; + int lgK = 12; + sk = new HllSketch(lgK, TgtHllType.HLL_4); //can be 4, 6, or 8 + for (int i = 0; i < (2 << lgK); i++) { sk.update(i); } + byte[] arr = HllSketch.toCompactByteArray(); + //... + union = Union.heapify(arr); //initializes the union using data from the array. + //OR, if used in an off-heap environment: + union = Union.heapify(Memory.wrap(arr)); //same as above, except from Memory object. + + //To recover an updatable heap sketch: + sk2 = HllSketch.heapify(arr); + //OR, if used in an off-heap environment: + sk2 = HllSketch.heapify(Memory.wrap(arr)); + </code></pre> + + <p>The sketch "wrapping" operation skips actual deserialization thus is quite fast. However, + any attempt to update the derived HllSketch will result in a Read-only exception.</p> + + <p>Note that in some cases, based on the state of the sketch, the compact form is + indistiguishable from the updatable form. In these cases the updatable form is returned + and the compact flag bit will not be set.</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch as a compact byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toUpdatableByteArray()"> +<h3>toUpdatableByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toUpdatableByteArray</span>()</div> +<div class="block">Serializes this sketch as a byte array in an updatable form. The updatable form is larger than + the compact form. The use of this form is primarily in environments that support updating + sketches in off-heap memory. If the sketch is constructed using HLL_8, sketch updating and + union updating operations can actually occur in WritableMemory, which can be off-heap: + <pre><code> + Union union; HllSketch sk; + int lgK = 12; + sk = new HllSketch(lgK, TgtHllType.HLL_8) //must be 8 + for (int i = 0; i < (2 << lgK); i++) { sk.update(i); } + byte[] arr = sk.toUpdatableByteArray(); + WritableMemory wmem = WritableMemory.wrap(arr); + //... + union = Union.writableWrap(wmem); //no deserialization! + </code></pre></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch as an updatable byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean,boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean summary, + boolean detail, + boolean auxDetail, + boolean all)</span></div> +<div class="block">Human readable summary with optional detail</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summary</code> - if true, output the sketch summary</dd> +<dd><code>detail</code> - if true, output the internal data array</dd> +<dd><code>auxDetail</code> - if true, output the internal Aux array, if it exists.</dd> +<dd><code>all</code> - if true, outputs all entries including empty ones</dd> +<dt>Returns:</dt> +<dd>human readable string with optional detail.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of an HllSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of an HllSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of an HllSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory object</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of an HllSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializationVersion()"> +<h3>getSerializationVersion</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">getSerializationVersion</span>()</div> +<div class="block">Returns the current serialization version.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current serialization version.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializationVersion(org.apache.datasketches.memory.Memory)"> +<h3>getSerializationVersion</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">getSerializationVersion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns the current serialization version of the given Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory containing a serialized HllSketch image.</dd> +<dt>Returns:</dt> +<dd>the current serialization version.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRelErr(boolean,boolean,int,int)"> +<h3>getRelErr</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getRelErr</span><wbr><span class="parameters">(boolean upperBound, + boolean oooFlag, + int lgConfigK, + int numStdDev)</span></div> +<div class="block">Gets the current (approximate) Relative Error (RE) asymptotic values given several + parameters. This is used primarily for testing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>upperBound</code> - return the RE for the Upper Bound, otherwise for the Lower Bound.</dd> +<dd><code>oooFlag</code> - set true if the sketch is the result of a non qualifying union operation.</dd> +<dd><code>lgConfigK</code> - the configured value for the sketch.</dd> +<dd><code>numStdDev</code> - the given number of Standard Deviations. This must be an integer between + 1 and 3, inclusive. + <a href="../../../../resources/dictionary.html#numStdDev">Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the current (approximate) RelativeError</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block">This HLL family of sketches and operators is always estimating, even for very small values.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Human readable summary as a string.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>Human readable summary as a string.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean summary, + boolean detail, + boolean auxDetail)</span></div> +<div class="block">Human readable summary with optional detail. Does not list empty entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summary</code> - if true, output the sketch summary</dd> +<dd><code>detail</code> - if true, output the internal data array</dd> +<dd><code>auxDetail</code> - if true, output the internal Aux array, if it exists.</dd> +<dt>Returns:</dt> +<dd>human readable string with optional detail.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long datum)</span></div> +<div class="block">Present the given long as a potential unique item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given long datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double datum)</span></div> +<div class="block">Present the given double (or float) datum as a potential unique item. + The double will be converted to a long using Double.doubleToLongBits(datum), + which normalizes all NaN values to a single NaN representation. + Plus and minus zero will be normalized to plus zero. + The special floating-point values NaN and +/- Infinity are treated as distinct.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given double datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</span></div> +<div class="block">Present the given String as a potential unique item. + The string is converted to a byte array using UTF8 encoding. + If the string is null or empty no update attempt is made and the method returns. + + <p>Note: About 2X faster performance can be obtained by first converting the String to a + char[] and updating the sketch with that. This bypasses the complexity of the Java UTF_8 + encoding. This, of course, will not produce the same internal hash values as updating directly + with a String. So be consistent! Unioning two sketches, one fed with strings and the other + fed with char[] will be meaningless. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given String.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.nio.ByteBuffer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</span></div> +<div class="block">Present the given byte buffer as a potential unique item. + Bytes are read from the current position of the buffer until its limit. + If the byte buffer is null or has no bytes remaining, no update attempt is made and the method returns. + + <p>This method will not modify the position, mark, limit, or byte order of the buffer.</p> + + <p>Little-endian order is preferred, but not required. This method may perform better if the provided byte + buffer is in little-endian order.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given byte buffer.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Present the given byte array as a potential unique item. + If the byte array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(char[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Present the given char array as a potential unique item. + If the char array is null or empty no update attempt is made and the method returns. + + <p>Note: this will not produce the same output hash values as the <i>update(String)</i> + method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given char array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Present the given integer array as a potential unique item. + If the integer array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given int array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Present the given long array as a potential unique item. + If the long array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given long array.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/TgtHllType.html b/docs/7.0.X/org/apache/datasketches/hll/TgtHllType.html new file mode 100644 index 000000000..fc99c0c14 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/TgtHllType.html @@ -0,0 +1,289 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>TgtHllType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hll, enum: TgtHllType"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/TgtHllType.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.hll</a></div> +<h1 title="Enum Class TgtHllType" class="title">Enum Class TgtHllType</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a>> +<div class="inheritance">org.apache.datasketches.hll.TgtHllType</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">TgtHllType</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a>></span></div> +<div class="block">Specifies the target type of HLL sketch to be created. It is a target in that the actual + allocation of the HLL array is deferred until sufficient number of items have been received by + the warm-up phases. + + <p>These three target types are isomorphic representations of the same underlying HLL algorithm. + Thus, given the same value of <i>lgConfigK</i> and the same input, all three HLL target types + will produce identical estimates and have identical error distributions.</p> + + <p>The memory (and also the serialization) of the sketch during this early warmup phase starts + out very small (8 bytes, when empty) and then grows in increments of 4 bytes as required + until the full HLL array is allocated. This transition point occurs at about 10% of K for + sketches where lgConfigK is > 8.</p> + + <ul> + <li><b>HLL 8</b> This uses an 8-bit byte per HLL bucket. It is generally the + fastest in terms of update time, but has the largest storage footprint of about + <i>K</i> bytes.</li> + + <li><b>HLL 6</b> This uses a 6-bit field per HLL bucket. It is the generally the next fastest + in terms of update time with a storage footprint of about <i>3/4 * K</i> bytes.</li> + + <li><b>HLL 4</b> This uses a 4-bit field per HLL bucket and for large counts may require + the use of a small internal auxiliary array for storing statistical exceptions, which are rare. + For the values of <i>lgConfigK > 13</i> (<i>K</i> = 8192), + this additional array adds about 3% to the overall storage. It is generally the slowest in + terms of update time, but has the smallest storage footprint of about + <i>K/2 * 1.03</i> bytes.</li> + </ul></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#HLL_4" class="member-name-link">HLL_4</a></code></div> +<div class="col-last even-row-color"> +<div class="block">An HLL sketch with a bin size of 4 bits</div> +</div> +<div class="col-first odd-row-color"><code><a href="#HLL_6" class="member-name-link">HLL_6</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">An HLL sketch with a bin size of 6 bits</div> +</div> +<div class="col-first even-row-color"><code><a href="#HLL_8" class="member-name-link">HLL_8</a></code></div> +<div class="col-last even-row-color"> +<div class="block">An Hll Sketch with a bin size of 8 bits</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromOrdinal(int)" class="member-name-link">fromOrdinal</a><wbr>(int typeId)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Convert the typeId to the enum type</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="HLL_4"> +<h3>HLL_4</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">HLL_4</span></div> +<div class="block">An HLL sketch with a bin size of 4 bits</div> +</section> +</li> +<li> +<section class="detail" id="HLL_6"> +<h3>HLL_6</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">HLL_6</span></div> +<div class="block">An HLL sketch with a bin size of 6 bits</div> +</section> +</li> +<li> +<section class="detail" id="HLL_8"> +<h3>HLL_8</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">HLL_8</span></div> +<div class="block">An Hll Sketch with a bin size of 8 bits</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="fromOrdinal(int)"> +<h3>fromOrdinal</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">fromOrdinal</span><wbr><span class="parameters">(int typeId)</span></div> +<div class="block">Convert the typeId to the enum type</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>typeId</code> - the given typeId</dd> +<dt>Returns:</dt> +<dd>the enum type</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/Union.html b/docs/7.0.X/org/apache/datasketches/hll/Union.html new file mode 100644 index 000000000..704de216a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/Union.html @@ -0,0 +1,972 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Union (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hll, class: Union"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Union.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.hll</a></div> +<h1 title="Class Union" class="title">Class Union</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.hll.Union</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Union</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This performs union operations for all HllSketches. This union operator can be configured to be + on or off heap. The source sketch given to this union using the <a href="#update(org.apache.datasketches.hll.HllSketch)"><code>update(HllSketch)</code></a> can + be configured with any precision value <i>lgConfigK</i> (from 4 to 21), any <i>TgtHllType</i> + (HLL_4, HLL_6, HLL_8), and either on or off-heap; and it can be in either of the sparse modes + (<i>LIST</i> or <i>SET</i>), or the dense mode (<i>HLL</i>). + + <p>Although the API for this union operator parallels many of the methods of the + <i>HllSketch</i>, the behavior of the union operator has some fundamental differences.</p> + + <p>First, this union operator is configured with a <i>lgMaxK</i> instead of the normal + <i>lgConfigK</i>. Generally, this union operator will inherit the lowest <i>lgConfigK</i> + less than <i>lgMaxK</i> that it has seen. However, the <i>lgConfigK</i> of incoming sketches that + are still in sparse are ignored. The <i>lgMaxK</i> provides the user the ability to specify the + largest maximum size for the union operation. + + <p>Second, the user cannot specify the <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a> as an input parameter to the union. + Instead, it is specified for the sketch returned with <a href="#getResult(org.apache.datasketches.hll.TgtHllType)"><code>getResult(TgtHllType)</code></a>. + + <p>The following graph illustrates the HLL Merge speed.</p> + + <p><img src="doc-files/HLL_UnionTime4_6_8_Java_CPP.png" width="500" alt="HLL LgK12 Union Speed"></p> + This graph illustrates the relative merging speed of the HLL 4,6,8 Java HLL sketches compared to + the DataSketches C++ implementations of the same sketches. With this particular test (merging 32 relative large + sketches together), the Java HLL 8 is the fastest and the Java HLL 4 the slowest, with a mixed cluster in the middle. + Union / Merging speed is somewhat difficult to measure as the performance is very dependent on the mix of sketch + sizes (and types) you are merging. So your mileage will vary! + + <p>For a complete example of using the Union operator + see <a href="https://datasketches.apache.org/docs/HLL/HllJavaExample.html">Union Example</a>.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Union</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct this Union operator with the default maximum log-base-2 of <i>K</i>.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">Union</a><wbr>(int lgMaxK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct this Union operator with a given maximum log-base-2 of <i>K</i>.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">Union</a><wbr>(int lgMaxK, + org.apache.datasketches.memory.WritableMemory dstWmem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct this Union operator with a given maximum log-base-2 of <i>K</i> and the given + WritableMemory as the destination for this Union.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompactSerializationBytes()" class="member-name-link">getCompactSerializationBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toCompactByteArray()</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompositeEstimate()" class="member-name-link">getCompositeEstimate</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is less accurate than the <i>getEstimate()</i> method and is automatically used + when the sketch has gone through union operations where the more accurate HIP estimator + cannot be used.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return the cardinality estimate</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgConfigK()" class="member-name-link">getLgConfigK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the effective <i>lgConfigK</i> for the union operator, which may be less than + <i>lgMaxK</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int)" class="member-name-link">getLowerBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxSerializationBytes(int)" class="member-name-link">getMaxSerializationBytes</a><wbr>(int lgK)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum size in bytes that this union operator can grow to given a lgK.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRelErr(boolean,boolean,int,int)" class="member-name-link">getRelErr</a><wbr>(boolean upperBound, + boolean oooFlag, + int lgConfigK, + int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the current (approximate) Relative Error (RE) asymptotic values given several + parameters.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return the result of this union operator as an HLL_4 sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">getResult</a><wbr>(<a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Return the result of this union operator with the specified <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializationVersion()" class="member-name-link">getSerializationVersion</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the current serialization version.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializationVersion(org.apache.datasketches.memory.Memory)" class="member-name-link">getSerializationVersion</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the current serialization version of the given Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTgtHllType()" class="member-name-link">getTgtHllType</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpdatableSerializationBytes()" class="member-name-link">getUpdatableSerializationBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toUpdatableByteArray()</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int)" class="member-name-link">getUpperBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="Union.html" title="class in org.apache.datasketches.hll">Union</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(byte%5B%5D)" class="member-name-link">heapify</a><wbr>(byte[] byteArray)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a union operator populated with the given byte array image of an HllSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="Union.html" title="class in org.apache.datasketches.hll">Union</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a union operator populated with the given Memory image of an HllSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCompact()" class="member-name-link">isCompact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the backing memory of this sketch is in compact form.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if empty</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This HLL family of sketches and operators is always estimating, even for very small values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMemory()" class="member-name-link">isMemory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch was created using Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isOffHeap()" class="member-name-link">isOffHeap</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the backing memory for this sketch is off-heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the given Memory refers to the same underlying resource as this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets to empty and retains the current lgK, but does not change the configured value of + lgMaxK.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toCompactByteArray()" class="member-name-link">toCompactByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the serialization of this union operator as a byte array in compact form, which is + designed to be heapified only.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human readable summary as a string.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean summary, + boolean detail, + boolean auxDetail)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human readable summary with optional detail.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean,boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean summary, + boolean hllDetail, + boolean auxDetail, + boolean all)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human readable summary with optional detail</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toUpdatableByteArray()" class="member-name-link">toUpdatableByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serializes this sketch as a byte array in an updatable form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given byte array as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(char%5B%5D)" class="member-name-link">update</a><wbr>(char[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given char array as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given double (or float) datum as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(int%5B%5D)" class="member-name-link">update</a><wbr>(int[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given integer array as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given long as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D)" class="member-name-link">update</a><wbr>(long[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given long array as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given String as a potential unique item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.nio.ByteBuffer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present the given byte buffer as a potential unique item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.hll.HllSketch)" class="member-name-link">update</a><wbr>(<a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a> sketch)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this union operator with the given sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="Union.html" title="class in org.apache.datasketches.hll">Union</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcWmem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable HLL_8 sketch, + and may have data.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>Union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Union</span>()</div> +<div class="block">Construct this Union operator with the default maximum log-base-2 of <i>K</i>.</div> +</section> +</li> +<li> +<section class="detail" id="<init>(int)"> +<h3>Union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Union</span><wbr><span class="parameters">(int lgMaxK)</span></div> +<div class="block">Construct this Union operator with a given maximum log-base-2 of <i>K</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgMaxK</code> - the desired maximum log-base-2 of <i>K</i>. This value must be + between 4 and 21 inclusively.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,org.apache.datasketches.memory.WritableMemory)"> +<h3>Union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Union</span><wbr><span class="parameters">(int lgMaxK, + org.apache.datasketches.memory.WritableMemory dstWmem)</span></div> +<div class="block">Construct this Union operator with a given maximum log-base-2 of <i>K</i> and the given + WritableMemory as the destination for this Union. This WritableMemory is usually configured + for off-heap memory. What remains on the java heap is a thin wrapper object that reads and + writes to the given WritableMemory. + + <p>The given <i>dstMem</i> is checked for the required capacity as determined by + <a href="HllSketch.html#getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)"><code>HllSketch.getMaxUpdatableSerializationBytes(int, TgtHllType)</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgMaxK</code> - the desired maximum log-base-2 of <i>K</i>. This value must be + between 4 and 21 inclusively.</dd> +<dd><code>dstWmem</code> - the destination writable memory for the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(byte[])"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Union.html" title="class in org.apache.datasketches.hll">Union</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(byte[] byteArray)</span></div> +<div class="block">Construct a union operator populated with the given byte array image of an HllSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArray</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a union operator populated with the given byte array image of an HllSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Union.html" title="class in org.apache.datasketches.hll">Union</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Construct a union operator populated with the given Memory image of an HllSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>a union operator populated with the given Memory image of an HllSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="writableWrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>writableWrap</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Union.html" title="class in org.apache.datasketches.hll">Union</a></span> <span class="element-name">writableWrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcWmem)</span></div> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable HLL_8 sketch, + and may have data. What remains on the java heap is a + thin wrapper object that reads and writes to the given WritableMemory, which, depending on + how the user configures the WritableMemory, may actually reside on the Java heap or off-heap. + + <p>The given <i>dstMem</i> is checked for the required capacity as determined by + <a href="HllSketch.html#getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)"><code>HllSketch.getMaxUpdatableSerializationBytes(int, TgtHllType)</code></a>, and for the correct type.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcWmem</code> - an writable image of a valid sketch with data.</dd> +<dt>Returns:</dt> +<dd>a Union operator where the sketch data is in the given dstMem.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompositeEstimate()"> +<h3>getCompositeEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getCompositeEstimate</span>()</div> +<div class="block">This is less accurate than the <i>getEstimate()</i> method and is automatically used + when the sketch has gone through union operations where the more accurate HIP estimator + cannot be used. + This is made public only for error characterization software that exists in separate + packages and is not intended for normal use.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the composite estimate</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactSerializationBytes()"> +<h3>getCompactSerializationBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCompactSerializationBytes</span>()</div> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toCompactByteArray()</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the size in bytes of the current sketch when serialized using + <i>toCompactByteArray()</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<div class="block">Return the cardinality estimate</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the cardinality estimate</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgConfigK()"> +<h3>getLgConfigK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgConfigK</span>()</div> +<div class="block">Gets the effective <i>lgConfigK</i> for the union operator, which may be less than + <i>lgMaxK</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the <i>lgConfigK</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - This must be an integer between 1 and 3, inclusive. + <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the lower bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxSerializationBytes(int)"> +<h3>getMaxSerializationBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxSerializationBytes</span><wbr><span class="parameters">(int lgK)</span></div> +<div class="block">Returns the maximum size in bytes that this union operator can grow to given a lgK.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - The maximum Log2 of K for this union operator. This value must be + between 4 and 21 inclusively.</dd> +<dt>Returns:</dt> +<dd>the maximum size in bytes that this union operator can grow to.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Return the result of this union operator as an HLL_4 sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of this union operator as an HLL_4 sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(org.apache.datasketches.hll.TgtHllType)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(<a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</span></div> +<div class="block">Return the result of this union operator with the specified <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tgtHllType</code> - the TgtHllType enum</dd> +<dt>Returns:</dt> +<dd>the result of this union operator with the specified TgtHllType</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getTgtHllType()"> +<h3>getTgtHllType</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span> <span class="element-name">getTgtHllType</span>()</div> +<div class="block">Gets the <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the TgtHllType enum value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpdatableSerializationBytes()"> +<h3>getUpdatableSerializationBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getUpdatableSerializationBytes</span>()</div> +<div class="block">Gets the size in bytes of the current sketch when serialized using + <i>toUpdatableByteArray()</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the size in bytes of the current sketch when serialized using + <i>toUpdatableByteArray()</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - This must be an integer between 1 and 3, inclusive. + <a href="../../../../resources/dictionary.html#numStdDev">Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the upper bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isCompact()"> +<h3>isCompact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCompact</span>()</div> +<div class="block">Returns true if the backing memory of this sketch is in compact form.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the backing memory of this sketch is in compact form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if empty</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if empty</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isMemory()"> +<h3>isMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMemory</span>()</div> +<div class="block">Returns true if this sketch was created using Memory.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch was created using Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isOffHeap()"> +<h3>isOffHeap</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOffHeap</span>()</div> +<div class="block">Returns true if the backing memory for this sketch is off-heap.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the backing memory for this sketch is off-heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isSameResource(org.apache.datasketches.memory.Memory)"> +<h3>isSameResource</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSameResource</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns true if the given Memory refers to the same underlying resource as this sketch. + The capacities must be the same. If <i>this</i> is a region, + the region offset must also be the same. + + <p>This is only relevant for HLL_4 sketches that have been configured for off-heap + using WritableMemory or Memory. For on-heap sketches or unions this will return false. + + <p>It is rare, but possible, the the off-heap memory that has been allocated to an HLL_4 + sketch may not be large enough. If this should happen, the sketch makes a request for more + memory from the owner of the resource and then moves itself to this new location. This all + happens transparently to the user. This method provides a means for the user to + inquire of the sketch if it has, in fact, moved itself.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>true if the given Memory refers to the same underlying resource as this sketch or + union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets to empty and retains the current lgK, but does not change the configured value of + lgMaxK.</div> +</section> +</li> +<li> +<section class="detail" id="toCompactByteArray()"> +<h3>toCompactByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toCompactByteArray</span>()</div> +<div class="block">Gets the serialization of this union operator as a byte array in compact form, which is + designed to be heapified only. It is not directly updatable. + For the Union operator, this is the serialization of the internal state of + the union operator as a sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the serialization of this union operator as a byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toUpdatableByteArray()"> +<h3>toUpdatableByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toUpdatableByteArray</span>()</div> +<div class="block">Serializes this sketch as a byte array in an updatable form. The updatable form is larger than + the compact form. The use of this form is primarily in environments that support updating + sketches in off-heap memory. If the sketch is constructed using HLL_8, sketch updating and + union updating operations can actually occur in WritableMemory, which can be off-heap: + <pre><code> + Union union; HllSketch sk; + int lgK = 12; + sk = new HllSketch(lgK, TgtHllType.HLL_8) //must be 8 + for (int i = 0; i < (2 << lgK); i++) { sk.update(i); } + byte[] arr = sk.toUpdatableByteArray(); + WritableMemory wmem = WritableMemory.wrap(arr); + //... + union = Union.writableWrap(wmem); //no deserialization! + </code></pre></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch as an updatable byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean,boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean summary, + boolean hllDetail, + boolean auxDetail, + boolean all)</span></div> +<div class="block">Human readable summary with optional detail</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summary</code> - if true, output the sketch summary</dd> +<dd><code>hllDetail</code> - if true, output the internal data array</dd> +<dd><code>auxDetail</code> - if true, output the internal Aux array, if it exists.</dd> +<dd><code>all</code> - if true, outputs all entries including empty ones</dd> +<dt>Returns:</dt> +<dd>human readable string with optional detail.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.hll.HllSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a> sketch)</span></div> +<div class="block">Update this union operator with the given sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - the given sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializationVersion()"> +<h3>getSerializationVersion</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">getSerializationVersion</span>()</div> +<div class="block">Returns the current serialization version.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current serialization version.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializationVersion(org.apache.datasketches.memory.Memory)"> +<h3>getSerializationVersion</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">getSerializationVersion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns the current serialization version of the given Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory containing a serialized HllSketch image.</dd> +<dt>Returns:</dt> +<dd>the current serialization version.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRelErr(boolean,boolean,int,int)"> +<h3>getRelErr</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getRelErr</span><wbr><span class="parameters">(boolean upperBound, + boolean oooFlag, + int lgConfigK, + int numStdDev)</span></div> +<div class="block">Gets the current (approximate) Relative Error (RE) asymptotic values given several + parameters. This is used primarily for testing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>upperBound</code> - return the RE for the Upper Bound, otherwise for the Lower Bound.</dd> +<dd><code>oooFlag</code> - set true if the sketch is the result of a non qualifying union operation.</dd> +<dd><code>lgConfigK</code> - the configured value for the sketch.</dd> +<dd><code>numStdDev</code> - the given number of Standard Deviations. This must be an integer between + 1 and 3, inclusive. + <a href="../../../../resources/dictionary.html#numStdDev">Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the current (approximate) RelativeError</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block">This HLL family of sketches and operators is always estimating, even for very small values.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Human readable summary as a string.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>Human readable summary as a string.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean summary, + boolean detail, + boolean auxDetail)</span></div> +<div class="block">Human readable summary with optional detail. Does not list empty entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summary</code> - if true, output the sketch summary</dd> +<dd><code>detail</code> - if true, output the internal data array</dd> +<dd><code>auxDetail</code> - if true, output the internal Aux array, if it exists.</dd> +<dt>Returns:</dt> +<dd>human readable string with optional detail.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long datum)</span></div> +<div class="block">Present the given long as a potential unique item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given long datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double datum)</span></div> +<div class="block">Present the given double (or float) datum as a potential unique item. + The double will be converted to a long using Double.doubleToLongBits(datum), + which normalizes all NaN values to a single NaN representation. + Plus and minus zero will be normalized to plus zero. + The special floating-point values NaN and +/- Infinity are treated as distinct.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given double datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</span></div> +<div class="block">Present the given String as a potential unique item. + The string is converted to a byte array using UTF8 encoding. + If the string is null or empty no update attempt is made and the method returns. + + <p>Note: About 2X faster performance can be obtained by first converting the String to a + char[] and updating the sketch with that. This bypasses the complexity of the Java UTF_8 + encoding. This, of course, will not produce the same internal hash values as updating directly + with a String. So be consistent! Unioning two sketches, one fed with strings and the other + fed with char[] will be meaningless. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given String.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.nio.ByteBuffer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</span></div> +<div class="block">Present the given byte buffer as a potential unique item. + Bytes are read from the current position of the buffer until its limit. + If the byte buffer is null or has no bytes remaining, no update attempt is made and the method returns. + + <p>This method will not modify the position, mark, limit, or byte order of the buffer.</p> + + <p>Little-endian order is preferred, but not required. This method may perform better if the provided byte + buffer is in little-endian order.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given byte buffer.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Present the given byte array as a potential unique item. + If the byte array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(char[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Present the given char array as a potential unique item. + If the char array is null or empty no update attempt is made and the method returns. + + <p>Note: this will not produce the same output hash values as the <i>update(String)</i> + method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given char array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Present the given integer array as a potential unique item. + If the integer array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given int array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Present the given long array as a potential unique item. + If the long array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given long array.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/class-use/HllSketch.html b/docs/7.0.X/org/apache/datasketches/hll/class-use/HllSketch.html new file mode 100644 index 000000000..e2053f607 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/class-use/HllSketch.html @@ -0,0 +1,139 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.hll.HllSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hll, class: HllSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../HllSketch.html" title="class in org.apache.datasketches.hll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.hll.HllSketch" class="title">Uses of Class<br>org.apache.datasketches.hll.HllSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.hll">org.apache.datasketches.hll</a></div> +<div class="col-last even-row-color"> +<div class="block">The DataSketches™ HLL sketch family package</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.hll"> +<h2>Uses of <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a> in <a href="../package-summary.html">org.apache.datasketches.hll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.hll</a> that return <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Return a copy of this sketch onto the Java heap.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#copyAs(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">copyAs</a><wbr>(<a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Return a deep copy of this sketch onto the Java heap with the specified TgtHllType.</div> +</div> +<div class="col-first even-row-color"><code><a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Return the result of this union operator as an HLL_4 sketch.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getResult(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">getResult</a><wbr>(<a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Return the result of this union operator with the specified <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +</div> +<div class="col-first even-row-color"><code>static final <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#heapify(byte%5B%5D)" class="member-name-link">heapify</a><wbr>(byte[] byteArray)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given byte array, which must be a valid HllSketch image and may have data.</div> +</div> +<div class="col-first odd-row-color"><code>static final <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given Memory, which must be a valid HllSketch image and may have data.</div> +</div> +<div class="col-first even-row-color"><code>static final <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wraps the given read-only Memory that must be a image of a valid sketch, + which may be in compact or updatable form, and should have data.</div> +</div> +<div class="col-first odd-row-color"><code>static final <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcWmem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable sketch, + and may have data.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.hll</a> with parameters of type <a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#update(org.apache.datasketches.hll.HllSketch)" class="member-name-link">update</a><wbr>(<a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Update this union operator with the given sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/class-use/TgtHllType.html b/docs/7.0.X/org/apache/datasketches/hll/class-use/TgtHllType.html new file mode 100644 index 000000000..b4e83e24a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/class-use/TgtHllType.html @@ -0,0 +1,161 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.hll.TgtHllType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hll, enum: TgtHllType"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.hll.TgtHllType" class="title">Uses of Enum Class<br>org.apache.datasketches.hll.TgtHllType</h1> +</div> +<div class="caption"><span>Packages that use <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.hll">org.apache.datasketches.hll</a></div> +<div class="col-last even-row-color"> +<div class="block">The DataSketches™ HLL sketch family package</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.hll"> +<h2>Uses of <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> in <a href="../package-summary.html">org.apache.datasketches.hll</a></h2> +<div class="caption"><span>Fields in <a href="../package-summary.html">org.apache.datasketches.hll</a> declared as <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#DEFAULT_HLL_TYPE" class="member-name-link">DEFAULT_HLL_TYPE</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The default HLL-TYPE is HLL_4</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.hll</a> that return <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">TgtHllType.</span><code><a href="../TgtHllType.html#fromOrdinal(int)" class="member-name-link">fromOrdinal</a><wbr>(int typeId)</code></div> +<div class="col-last even-row-color"> +<div class="block">Convert the typeId to the enum type</div> +</div> +<div class="col-first odd-row-color"><code><a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#getTgtHllType()" class="member-name-link">getTgtHllType</a>()</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getTgtHllType()" class="member-name-link">getTgtHllType</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>static <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">TgtHllType.</span><code><a href="../TgtHllType.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">TgtHllType.</span><code><a href="../TgtHllType.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.hll</a> with parameters of type <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#copyAs(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">copyAs</a><wbr>(<a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Return a deep copy of this sketch onto the Java heap with the specified TgtHllType.</div> +</div> +<div class="col-first odd-row-color"><code>static final int</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">HllSketch.</span><code><a href="../HllSketch.html#getMaxUpdatableSerializationBytes(int,org.apache.datasketches.hll.TgtHllType)" class="member-name-link">getMaxUpdatableSerializationBytes</a><wbr>(int lgConfigK, + <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the maximum size in bytes that this sketch can grow to given lgConfigK.</div> +</div> +<div class="col-first even-row-color"><code><a href="../HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getResult(org.apache.datasketches.hll.TgtHllType)" class="member-name-link">getResult</a><wbr>(<a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Return the result of this union operator with the specified <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a></div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.hll</a> with parameters of type <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../HllSketch.html#%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType)" class="member-name-link">HllSketch</a><wbr>(int lgConfigK, + <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new on-heap sketch with the type of HLL sketch to configure.</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../HllSketch.html#%3Cinit%3E(int,org.apache.datasketches.hll.TgtHllType,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">HllSketch</a><wbr>(int lgConfigK, + <a href="../TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a> tgtHllType, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a new sketch with the type of HLL sketch to configure and the given + WritableMemory as the destination for the sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/class-use/Union.html b/docs/7.0.X/org/apache/datasketches/hll/class-use/Union.html new file mode 100644 index 000000000..b6ef44843 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/class-use/Union.html @@ -0,0 +1,102 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.hll.Union (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hll, class: Union"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Union.html" title="class in org.apache.datasketches.hll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.hll.Union" class="title">Uses of Class<br>org.apache.datasketches.hll.Union</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Union.html" title="class in org.apache.datasketches.hll">Union</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.hll">org.apache.datasketches.hll</a></div> +<div class="col-last even-row-color"> +<div class="block">The DataSketches™ HLL sketch family package</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.hll"> +<h2>Uses of <a href="../Union.html" title="class in org.apache.datasketches.hll">Union</a> in <a href="../package-summary.html">org.apache.datasketches.hll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.hll</a> that return <a href="../Union.html" title="class in org.apache.datasketches.hll">Union</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="../Union.html" title="class in org.apache.datasketches.hll">Union</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#heapify(byte%5B%5D)" class="member-name-link">heapify</a><wbr>(byte[] byteArray)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct a union operator populated with the given byte array image of an HllSketch.</div> +</div> +<div class="col-first odd-row-color"><code>static final <a href="../Union.html" title="class in org.apache.datasketches.hll">Union</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct a union operator populated with the given Memory image of an HllSketch.</div> +</div> +<div class="col-first even-row-color"><code>static final <a href="../Union.html" title="class in org.apache.datasketches.hll">Union</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#writableWrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcWmem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wraps the given WritableMemory, which must be a image of a valid updatable HLL_8 sketch, + and may have data.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/doc-files/HLL_HIP_K12T20U20.png b/docs/7.0.X/org/apache/datasketches/hll/doc-files/HLL_HIP_K12T20U20.png new file mode 100644 index 000000000..7d3c8348f Binary files /dev/null and b/docs/7.0.X/org/apache/datasketches/hll/doc-files/HLL_HIP_K12T20U20.png differ diff --git a/docs/7.0.X/org/apache/datasketches/hll/doc-files/HLL_UnionTime4_6_8_Java_CPP.png b/docs/7.0.X/org/apache/datasketches/hll/doc-files/HLL_UnionTime4_6_8_Java_CPP.png new file mode 100644 index 000000000..23225887b Binary files /dev/null and b/docs/7.0.X/org/apache/datasketches/hll/doc-files/HLL_UnionTime4_6_8_Java_CPP.png differ diff --git a/docs/7.0.X/org/apache/datasketches/hll/package-summary.html b/docs/7.0.X/org/apache/datasketches/hll/package-summary.html new file mode 100644 index 000000000..b42c25d03 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/package-summary.html @@ -0,0 +1,262 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.hll (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hll"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.hll" class="title">Package org.apache.datasketches.hll</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.hll</span></div> +<section class="package-description" id="package-description"> +<div class="block"><h2>The DataSketches™ HLL sketch family package</h2> + <a href="HllSketch.html" title="class in org.apache.datasketches.hll"><code>HllSketch</code></a> and <a href="Union.html" title="class in org.apache.datasketches.hll"><code>Union</code></a> + are the public facing classes of this high performance implementation of Phillipe Flajolet's + HyperLogLog algorithm[1] but with significantly improved error behavior and important features that can be + essential for large production systems that must handle massive data. + + <h2>Key Features of the DataSketches™ HLL Sketch and its companion Union</h2> + + <h3>Advanced Estimation Algorithms for Optimum Accuracy</h3> + + <h4>Zero error at low cardinalities</h4> + The HLL sketch leverages highly compact arrays and hash tables to keep exact counts until the transition to + dense mode is required for space reasons. The result is perfect accuracy for very low cardinalities. + + <p>Accuracy for very small streams can be important because Big Data is often fragmented into millions of smaller + streams (or segments) that inevitably are power-law distributed in size. If you are sketching all these fragments, + as a general rule, more than 80% of your sketches will be very small, 20% will be much larger, and only a few very + large in cardinality. + + <h4>HIP / Martingale Estimator</h4> + When obtaining a cardinality estimate, the sketch automatically determines if it was the result of the capture of + a single stream, or if was the result of certain qualifying union operations. If this is the case the sketch will + take advantage of Edith Cohen's Historical Inverse Probability (HIP) estimation algorithm[2], which was + also independently developed by Daniel Ting as the Martingale estimation algorithm[3]. + This will result in a 20% improvement in accuracy over the standard Flajolet estimator. + If it is not a single stream or if the specific union operation did not qualify, + the estimator will default to the Composite Estimator. + + <h4>Composite Estimator</h4> + This advanced estimator is a blend of several algorithms including new algorithms developed by Kevin Lang for his + Compressed Probabilistic Counting (CPC) sketch[4]. These algorithms provide near optimal estimation accuracy + for cases that don't qualify for HIP / Martingale estimation. + + <p>As a result of all of this work on accuracy, one will get a very smooth curve of the underlying accuracy of the + sketch once the statistical randomness is removed through multiple trials. This can be observed in the + following graph.</p> + + <p><img src="doc-files/HLL_HIP_K12T20U20.png" width="500" alt="HLL Accuracy">[6]</p> + + <p>The above graph has 7 curves. At y = 0, is the median line that hugs the x-axis so closely that it can't be seen. + The two curves, just above and just below the x-axis, correspond to +/- 1 standard deviation (SD) of error. + The distance between either one of this pair and the x-axis is also known as the Relative Standard Error (RSE). + This type of graph for illustrating sketch error we call a "pitchfork plot".</p> + + <p>The next two curves above and below correspond to +/- 2 SD, and + the top-most and bottom-most curves correspond to +/- 3 SD. + The chart grid lines are set at +/- multiples of Relative Standard Error (RSE) that correspond to +/- 1,2,3 SD. + Below the cardinality of about 512 there is no error at all. This is the point where this particular + sketch transitions from sparse to dense (or estimation) mode.</p> + + <h3>Three HLL Types</h3> + This HLL implementation offers three different types of HLL sketch, each with different + trade-offs with accuracy, space and performance. These types are selected with the + <a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll"><code>TgtHllType</code></a> parameter. + + <p>In terms of accuracy, all three types, for the same <i>lgConfigK</i>, have the same error + distribution as a function of cardinality.</p> + + <p>The configuration parameter <i>lgConfigK</i> is the log-base-2 of <i>K</i>, + where <i>K</i> is the number of buckets or slots for the sketch. <i>lgConfigK</i> impacts both accuracy and + the size of the sketch in memory and when stored.</p> + + <h4>HLL 8</h4> + This uses an 8-bit byte per HLL bucket. It is generally the + fastest in terms of update time but has the largest storage footprint of about <i>K</i> bytes. + + <h4>HLL 6</h4> + This uses a 6-bit field per HLL bucket. It is the generally the next fastest + in terms of update time with a storage footprint of about <i>3/4 * K</i> bytes. + + <h4>HLL 4</h4> + This uses a 4-bit field per HLL bucket and for large counts may require + the use of a small internal auxiliary array for storing statistical exceptions, which are rare. + For the values of <i>lgConfigK > 13</i> (<i>K</i> = 8192), + this additional array adds about 3% to the overall storage. It is generally the slowest in + terms of update time, but has the smallest storage footprint of about <i>K/2 * 1.03</i> bytes. + + <h3>Off-Heap Operation</h3> + This HLL sketch also offers the capability of operating off-heap. Given a <i>WritableMemory[5]</i> object + created by the user, the sketch will perform all of its updates and internal phase transitions + in that object, which can actually reside either on-heap or off-heap based on how it was + configured. In large systems that must update and union many millions of sketches, having the + sketch operate off-heap avoids the serialization and deserialization costs of moving sketches from heap to + off-heap and back, and reduces the need for garbage collection. + + <h3>Merging sketches with different configured <i>lgConfigK</i></h3> + This enables a user to union a HLL sketch that was configured with, say, <i>lgConfigK = 12</i> + with another loaded HLL sketch that was configured with, say, <i>lgConfigK = 14</i>. + + <p>Why is this important? Suppose you have been building a history of sketches of your customer's + data that go back a full year (or 5 or 10!) that were all configured with <i>lgConfigK = 12</i>. Because sketches + are so much smaller than the raw data it is possible that the raw data was discarded keeping only the sketches. + Even if you have the raw data, it might be very expensive and time consuming to reload and rebuild all your + sketches with a larger more accurate size, say, <i>lgConfigK = 14</i>. + This capability enables you to merge last year's data with this year's data built with larger sketches and still + have meaningful results.</p> + + <p>In other words, you can change your mind about what size sketch you need for your application at any time and + will not lose access to the data contained in your older historical sketches.</p> + + <p>This capability does come with a caveat: The resulting accuracy of the merged sketch will be the accuracy of the + smaller of the two sketches. Without this capability, you would either be stuck with the configuration you first + chose forever, or you would have to rebuild all your sketches from scratch, or worse, not be able to recover your + historical data.</p> + + <h3>Multi-language, multi-platform.</h3> + The binary structures for our sketch serializations are language and platform independent. + This means it is possible to generate an HLL sketch on a C++ Windows platform and it can be used on a + Java or Python Unix platform. + + <p>[1] Philippe Flajolet, et al, <a href="https://algo.inria.fr/flajolet/Publications/FlFuGaMe07.pdf"> +<i>HyperLogLog: the analysis of a near-optimal cardinality estimation algorithm.</i></a> + DMTCS proc. <b>AH</b>, 2007, 127-146. + + <p>[2] Edith Cohen, <a href="https://arxiv.org/pdf/1306.3284.pdf"> +<i>All-Distances Sketches, Revisited: HIP Estimators for Massive Graphs Analysis.</i></a> + PODS'14, June 22-27, Snowbird, UT, USA. + + <p>[3] Daniel Ting, + <a href="https://research.facebook.com/publications/streamed-approximate-counting-of-distinct-elements"> +<i>Streamed Approximate Counting of Distinct Elements, Beating Optimal Batch Methods.</i></a> + KDD'14 August 24, 2014 New York, New York USA. + + <p>[4] Kevin Lang, + <a href="https://arxiv.org/abs/1708.06839"> +<i>Back to the Future: an Even More Nearly Optimal Cardinality Estimation Algorithm.</i></a> + arXiv 1708.06839, August 22, 2017, Yahoo Research. + + <p>[5] Memory Component, + <a href="https://datasketches.apache.org/docs/Memory/MemoryComponent.html"> +<i>DataSketches Memory Component</i></a> + + <p>[6] MacBook Pro 2.3 GHz 8-Core Intel Core i9</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc"><code>CpcSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The HllSketch is actually a collection of compact implementations of Phillipe Flajolet’s HyperLogLog (HLL) + sketch but with significantly improved error behavior and excellent speed performance.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="TgtHllType.html" title="enum class in org.apache.datasketches.hll">TgtHllType</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block">Specifies the target type of HLL sketch to be created.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Union.html" title="class in org.apache.datasketches.hll">Union</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This performs union operations for all HllSketches.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/package-tree.html b/docs/7.0.X/org/apache/datasketches/hll/package-tree.html new file mode 100644 index 000000000..05082f20c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/package-tree.html @@ -0,0 +1,91 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.hll Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.hll"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.hll</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.hll.<a href="HllSketch.html" class="type-name-link" title="class in org.apache.datasketches.hll">HllSketch</a></li> +<li class="circle">org.apache.datasketches.hll.<a href="Union.html" class="type-name-link" title="class in org.apache.datasketches.hll">Union</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.hll.<a href="TgtHllType.html" class="type-name-link" title="enum class in org.apache.datasketches.hll">TgtHllType</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hll/package-use.html b/docs/7.0.X/org/apache/datasketches/hll/package-use.html new file mode 100644 index 000000000..704035b9e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hll/package-use.html @@ -0,0 +1,97 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.hll (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hll"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.hll" class="title">Uses of Package<br>org.apache.datasketches.hll</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.hll</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.hll">org.apache.datasketches.hll</a></div> +<div class="col-last even-row-color"> +<div class="block">The DataSketches™ HLL sketch family package</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.hll"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.hll</a> used by <a href="package-summary.html">org.apache.datasketches.hll</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/HllSketch.html#org.apache.datasketches.hll">HllSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">The HllSketch is actually a collection of compact implementations of Phillipe Flajolet’s HyperLogLog (HLL) + sketch but with significantly improved error behavior and excellent speed performance.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/TgtHllType.html#org.apache.datasketches.hll">TgtHllType</a></div> +<div class="col-last odd-row-color"> +<div class="block">Specifies the target type of HLL sketch to be created.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/Union.html#org.apache.datasketches.hll">Union</a></div> +<div class="col-last even-row-color"> +<div class="block">This performs union operations for all HllSketches.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hllmap/UniqueCountMap.html b/docs/7.0.X/org/apache/datasketches/hllmap/UniqueCountMap.html new file mode 100644 index 000000000..b6fd3cc0c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hllmap/UniqueCountMap.html @@ -0,0 +1,403 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UniqueCountMap (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hllmap, class: UniqueCountMap"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UniqueCountMap.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.hllmap</a></div> +<h1 title="Class UniqueCountMap" class="title">Class UniqueCountMap</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.hllmap.UniqueCountMap</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">UniqueCountMap</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This is a real-time, key-value HLL mapping sketch that tracks approximate unique counts of + identifiers (the values) associated with each key. An example might be tracking the number of + unique user identifiers associated with each IP address. This map has been specifically designed + for the use-case where the number of keys is quite large (many millions) and the distribution of + identifiers per key is very skewed. A typical distribution where this works well is a + power-law distribution of identifiers per key of the form <i>y = Cx<sup>-α</sup></i>, + where <i>α</i> < 0.5, and <i>C</i> is roughly <i>y<sub>max</sub></i>. + For example, with 100M keys, over 75% of the keys would have only + one identifier, 99% of the keys would have less than 20 identifiers, 99.9% would have less than + 200 identifiers, and a very tiny fraction might have identifiers in the thousands. + + <p>The space consumed by this map is quite sensitive to the actual distribution of identifiers + per key, so you should characterize and or experiment with your typical input streams. + Nonetheless, our experiments on live streams of over 100M keys required about 1.4GB of space. + This is about 14 bytes per key for key storage and unique count storage. + + <p>Given such highly-skewed distributions, using this map is far more efficient space-wise than + the alternative of dedicating an HLL sketch per key. Based on our use cases, after + subtracting the space required for key storage, the average bytes per key required for unique + count estimation (<a href="#getAverageSketchMemoryPerKey()"><code>getAverageSketchMemoryPerKey()</code></a>) is about 10. + + <p>Internally, this map is implemented as a hierarchy of internal hash maps with progressively + increasing storage allocated for unique count estimation. As a key acquires more identifiers it + is "promoted" up to a higher internal map. The final map of keys is a map of compact HLL + sketches. + + <p>The unique values in all the internal maps, except the final HLL map, are stored in a special + form called a coupon. A coupon is a 16-bit value that fully describes a k=1024 HLL bin. + It contains 10 bits of address and a 6-bit HLL value. + + <p>All internal maps use a prime number size and Knuth's Open Addressing Double Hash (OADH) + search algorithm. + + <p>The internal base map holds all the keys and each key is associated with one 16-bit value. + Initially, the value is a single coupon. Once the key is promoted, this 16-bit field contains a + reference to the internal map where the key is still active. + + <p>The intermediate maps between the base map and the final HLL map are of two types. + The first few of these are called traverse maps where the coupons are + stored as unsorted arrays. After the traverse maps are the coupon hash maps, where the coupons + are stored in small OASH hash tables. + + <p>All the intermediate maps support deletes and can dynamically grow and shrink as required by + the input stream. + + <p>The sketch estimator algorithms are unbiased with a Relative Standard Error (RSE) + of about 2.6% with 68% confidence, or equivalently, about 5.2% with a 95% confidence. + + <p>In a parallel package in the sketches-misc repository, there are 2 classes that can be used + from the command line to feed this mapping sketch piped from standard-in for experimental + evaluation. The first is ProcessIpStream, which processes simple IP/ID pairs and the second, + ProcessDistributionStream, which processes pairs that describe a distribution. + In this same package is the VariousMapRSETest class that was used to generate the error plots + for the web site. Please refer to the javadocs for those classes for more information.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Alexander Saydakov, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">UniqueCountMap</a><wbr>(int keySizeBytes)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a UniqueCountMap with an initial capacity of one million entries.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,int)" class="member-name-link">UniqueCountMap</a><wbr>(int initialNumEntries, + int keySizeBytes)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a UniqueCountMap with a given initial number of entries.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActiveEntries()" class="member-name-link">getActiveEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of active, unique keys across all internal maps</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAverageSketchMemoryPerKey()" class="member-name-link">getAverageSketchMemoryPerKey</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the average memory storage per key that is dedicated to sketching the unique counts.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate(byte%5B%5D)" class="member-name-link">getEstimate</a><wbr>(byte[] key)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Retrieves the current estimate of unique count for a given key.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKeyMemoryUsageBytes()" class="member-name-link">getKeyMemoryUsageBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns total bytes used for key storage</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(byte%5B%5D)" class="member-name-link">getLowerBound</a><wbr>(byte[] key)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the lower bound cardinality with respect to <a href="#getEstimate(byte%5B%5D)"><code>getEstimate(byte[])</code></a> associated + with the given key.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMemoryUsageBytes()" class="member-name-link">getMemoryUsageBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns total bytes used by all internal maps</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(byte%5B%5D)" class="member-name-link">getUpperBound</a><wbr>(byte[] key)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the upper bound cardinality with respect to <a href="#getEstimate(byte%5B%5D)"><code>getEstimate(byte[])</code></a> associated + with the given key.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a string with a human-readable summary of the UniqueCountMap and all the internal maps</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D,byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] key, + byte[] identifier)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the map with a given key and identifier and returns the estimate of the number of + unique identifiers encountered so far for the given key.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int)"> +<h3>UniqueCountMap</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">UniqueCountMap</span><wbr><span class="parameters">(int keySizeBytes)</span></div> +<div class="block">Constructs a UniqueCountMap with an initial capacity of one million entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>keySizeBytes</code> - must be at least 4 bytes to have sufficient entropy.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,int)"> +<h3>UniqueCountMap</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">UniqueCountMap</span><wbr><span class="parameters">(int initialNumEntries, + int keySizeBytes)</span></div> +<div class="block">Constructs a UniqueCountMap with a given initial number of entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>initialNumEntries</code> - The initial number of entries provides a tradeoff between + wasted space, if too high, and wasted time resizing the table, if too low.</dd> +<dd><code>keySizeBytes</code> - must be at least 4 bytes to have sufficient entropy</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(byte[],byte[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] key, + byte[] identifier)</span></div> +<div class="block">Updates the map with a given key and identifier and returns the estimate of the number of + unique identifiers encountered so far for the given key.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - the given key</dd> +<dd><code>identifier</code> - the given identifier for unique counting associated with the key</dd> +<dt>Returns:</dt> +<dd>the estimate of the number of unique identifiers encountered so far for the given key.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate(byte[])"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span><wbr><span class="parameters">(byte[] key)</span></div> +<div class="block">Retrieves the current estimate of unique count for a given key.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - given key</dd> +<dt>Returns:</dt> +<dd>estimate of unique count so far</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(byte[])"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(byte[] key)</span></div> +<div class="block">Returns the upper bound cardinality with respect to <a href="#getEstimate(byte%5B%5D)"><code>getEstimate(byte[])</code></a> associated + with the given key.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - the given key</dd> +<dt>Returns:</dt> +<dd>the upper bound cardinality with respect to <a href="#getEstimate(byte%5B%5D)"><code>getEstimate(byte[])</code></a> associated + with the given key.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(byte[])"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(byte[] key)</span></div> +<div class="block">Returns the lower bound cardinality with respect to <a href="#getEstimate(byte%5B%5D)"><code>getEstimate(byte[])</code></a> associated + with the given key.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - the given key</dd> +<dt>Returns:</dt> +<dd>the lower bound cardinality with respect to <a href="#getEstimate(byte%5B%5D)"><code>getEstimate(byte[])</code></a> associated + with the given key.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getActiveEntries()"> +<h3>getActiveEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getActiveEntries</span>()</div> +<div class="block">Returns the number of active, unique keys across all internal maps</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of active, unique keys across all internal maps</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMemoryUsageBytes()"> +<h3>getMemoryUsageBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMemoryUsageBytes</span>()</div> +<div class="block">Returns total bytes used by all internal maps</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>total bytes used by all internal maps</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getKeyMemoryUsageBytes()"> +<h3>getKeyMemoryUsageBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getKeyMemoryUsageBytes</span>()</div> +<div class="block">Returns total bytes used for key storage</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>total bytes used for key storage</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getAverageSketchMemoryPerKey()"> +<h3>getAverageSketchMemoryPerKey</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAverageSketchMemoryPerKey</span>()</div> +<div class="block">Returns the average memory storage per key that is dedicated to sketching the unique counts.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the average memory storage per key that is dedicated to sketching the unique counts.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a string with a human-readable summary of the UniqueCountMap and all the internal maps</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>human-readable summary</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hllmap/class-use/UniqueCountMap.html b/docs/7.0.X/org/apache/datasketches/hllmap/class-use/UniqueCountMap.html new file mode 100644 index 000000000..ef4b9abc4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hllmap/class-use/UniqueCountMap.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.hllmap.UniqueCountMap (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hllmap, class: UniqueCountMap"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.hllmap.UniqueCountMap" class="title">Uses of Class<br>org.apache.datasketches.hllmap.UniqueCountMap</h1> +</div> +No usage of org.apache.datasketches.hllmap.UniqueCountMap</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hllmap/package-summary.html b/docs/7.0.X/org/apache/datasketches/hllmap/package-summary.html new file mode 100644 index 000000000..9b7bc5baa --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hllmap/package-summary.html @@ -0,0 +1,127 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.hllmap (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.hllmap"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.hllmap" class="title">Package org.apache.datasketches.hllmap</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.hllmap</span></div> +<section class="package-description" id="package-description"> +<div class="block">The hllmap package contains a space efficient HLL mapping sketch of keys to approximate unique + count of identifiers. For example, counting the number of unique users (identifiers) per IP + address. + + <p>In cases where the number of keys is very large, having an individual HLL sketch per key may + not be practical. If the distribution of values per key is highly skewed where the vast + majority of keys have only a few values then this mapping sketch will make sense as it will be + far more space efficient than dedicating individual HLL sketches per key. + + <p>From our own testing, sketching 100 million IPv4 addresses with such a + highly skewed distribution of identifiers per IP uses only 1.4GB of memory. This translates to + an average of about 10 bytes per IP allocated to the equivalent of a full k=1024 HLL sketch + and provides an RSE of less than 2.5%. Your results will vary depending on the actual + distribution of identifiers per key.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="UniqueCountMap.html" title="class in org.apache.datasketches.hllmap"><code>UniqueCountMap</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This is a real-time, key-value HLL mapping sketch that tracks approximate unique counts of + identifiers (the values) associated with each key.</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hllmap/package-tree.html b/docs/7.0.X/org/apache/datasketches/hllmap/package-tree.html new file mode 100644 index 000000000..5716ccd77 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hllmap/package-tree.html @@ -0,0 +1,76 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.hllmap Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.hllmap"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.hllmap</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.hllmap.<a href="UniqueCountMap.html" class="type-name-link" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/hllmap/package-use.html b/docs/7.0.X/org/apache/datasketches/hllmap/package-use.html new file mode 100644 index 000000000..72409ed6b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/hllmap/package-use.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.hllmap (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.hllmap"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.hllmap" class="title">Uses of Package<br>org.apache.datasketches.hllmap</h1> +</div> +No usage of org.apache.datasketches.hllmap</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/kll/KllDoublesSketch.html new file mode 100644 index 000000000..0a66ec5ef --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllDoublesSketch.html @@ -0,0 +1,852 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllDoublesSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllDoublesSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllDoublesSketch" class="title">Class KllDoublesSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketch.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketch</a> +<div class="inheritance">org.apache.datasketches.kll.KllDoublesSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">KllDoublesSketch</span> +<span class="extends-implements">extends <a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> +implements <a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></div> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="KllSketch.html" title="class in org.apache.datasketches.kll"><code>KllSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-org.apache.datasketches.kll.KllSketch">Nested classes/interfaces inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h2> +<code><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>, <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></code></div> +</section> +</li> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.kll.KllSketch">Fields inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#DEFAULT_K">DEFAULT_K</a>, <a href="KllSketch.html#MAX_K">MAX_K</a></code></div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(double[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Merges another sketch into this one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance()" class="member-name-link">newHeapInstance</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance(int)" class="member-name-link">newHeapInstance</a><wbr>(int k)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean withLevels, + boolean withLevelsAndItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double%5B%5D,int,int)" class="member-name-link">update</a><wbr>(double[] items, + int offset, + int length)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Vector update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double,long)" class="member-name-link">update</a><wbr>(double item, + long weight)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Weighted update.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketch">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#getKFromEpsilon(double,boolean)">getKFromEpsilon</a>, <a href="KllSketch.html#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)">getMaxSerializedSizeBytes</a>, <a href="KllSketch.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNormalizedRankError(int,boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNumRetained()">getNumRetained</a>, <a href="KllSketch.html#getSerializedSizeBytes()">getSerializedSizeBytes</a>, <a href="KllSketch.html#hasMemory()">hasMemory</a>, <a href="KllSketch.html#isCompactMemoryFormat()">isCompactMemoryFormat</a>, <a href="KllSketch.html#isDirect()">isDirect</a>, <a href="KllSketch.html#isEmpty()">isEmpty</a>, <a href="KllSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="KllSketch.html#isMemoryUpdatableFormat()">isMemoryUpdatableFormat</a>, <a href="KllSketch.html#isReadOnly()">isReadOnly</a>, <a href="KllSketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="KllSketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a>, <a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a>, <a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a>, <a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesDoublesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getMaxItem()">getMaxItem</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getMinItem()">getMinItem</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double)">getRank</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D)">getRanks</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getSerializedSizeBytes()">getSerializedSizeBytes</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newHeapInstance()"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span> <span class="element-name">newHeapInstance</span>()</div> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>new KllDoublesSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newHeapInstance(int)"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span> <span class="element-name">newHeapInstance</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>. + <em>k</em> can be between 8, inclusive, and 65535, inclusive. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> +<dt>Returns:</dt> +<dd>new KllDoublesSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>newDirectInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span> <span class="element-name">newDirectInstance</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger <em>k</em> will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>a new direct instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>newDirectInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span> <span class="element-name">newDirectInstance</span><wbr><span class="parameters">(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> +<dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>a new direct instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch. + The resulting sketch will not retain any link to the source Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a compact Memory image of a sketch serialized by this sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a heap-based sketch based on the given Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the read only source Memory</dd> +<dt>Returns:</dt> +<dd>instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>writableWrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span> <span class="element-name">writableWrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a WritableMemory that contains data.</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(double quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(double[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#iterator()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.kll.KllSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">KllSketch</a></code></span></div> +<div class="block">Merges another sketch into this one. + Attempting to merge a sketch of the wrong type will throw an exception.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">merge</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch to merge into this one</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p> + + <p>The parameter <i>k</i> will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#toByteArray()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean withLevels, + boolean withLevelsAndItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#toString(boolean,boolean)">KllSketch</a></code></span></div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#toString(boolean,boolean)">toString</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>withLevels</code> - if true includes sketch levels array summary information</dd> +<dd><code>withLevelsAndItems</code> - if true include detail of levels array and items array together</dd> +<dt>Returns:</dt> +<dd>human readable summary information about this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#update(double)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#update(double)">update</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of items. NaNs are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double,long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double item, + long weight)</span></div> +<div class="block">Weighted update. Updates this sketch with the given item the number of times specified by the given integer weight.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be repeated. NaNs are ignored.</dd> +<dd><code>weight</code> - the number of times the update of item is to be repeated. It must be ≥ one.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double[],int,int)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double[] items, + int offset, + int length)</span></div> +<div class="block">Vector update. Updates this sketch with the given array (vector) of items, starting at the items + offset for a length number of items. This is not supported for direct sketches.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>items</code> - the vector of items</dd> +<dd><code>offset</code> - the starting index of the items[] array</dd> +<dd><code>length</code> - the number of items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getSortedView()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllDoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/KllDoublesSketchIterator.html new file mode 100644 index 000000000..cabb830b3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllDoublesSketchIterator.html @@ -0,0 +1,163 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllDoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllDoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllDoublesSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllDoublesSketchIterator" class="title">Class KllDoublesSketchIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketchIterator</a> +<div class="inheritance">org.apache.datasketches.kll.KllDoublesSketchIterator</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code>, <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">KllDoublesSketchIterator</span> +<span class="extends-implements">extends <a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a> +implements <a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="block">Iterator over KllDoublesSketch. The order is not defined.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the double quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketchIterator">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></h3> +<code><a href="KllSketchIterator.html#getWeight()">getWeight</a>, <a href="KllSketchIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html#getQuantile()">QuantilesDoublesSketchIterator</a></code></span></div> +<div class="block">Gets the double quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html#getQuantile()">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the double quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllFloatsSketch.html b/docs/7.0.X/org/apache/datasketches/kll/KllFloatsSketch.html new file mode 100644 index 000000000..c249112d1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllFloatsSketch.html @@ -0,0 +1,852 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllFloatsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllFloatsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllFloatsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllFloatsSketch" class="title">Class KllFloatsSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketch.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketch</a> +<div class="inheritance">org.apache.datasketches.kll.KllFloatsSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">KllFloatsSketch</span> +<span class="extends-implements">extends <a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> +implements <a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></span></div> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="KllSketch.html" title="class in org.apache.datasketches.kll"><code>KllSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-org.apache.datasketches.kll.KllSketch">Nested classes/interfaces inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h2> +<code><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>, <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></code></div> +</section> +</li> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.kll.KllSketch">Fields inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#DEFAULT_K">DEFAULT_K</a>, <a href="KllSketch.html#MAX_K">MAX_K</a></code></div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(float[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Merges another sketch into this one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance()" class="member-name-link">newHeapInstance</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance(int)" class="member-name-link">newHeapInstance</a><wbr>(int k)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean withLevels, + boolean withLevelsAndItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(float)" class="member-name-link">update</a><wbr>(float item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(float%5B%5D,int,int)" class="member-name-link">update</a><wbr>(float[] items, + int offset, + int length)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Vector update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(float,long)" class="member-name-link">update</a><wbr>(float item, + long weight)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Weighted update.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketch">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#getKFromEpsilon(double,boolean)">getKFromEpsilon</a>, <a href="KllSketch.html#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)">getMaxSerializedSizeBytes</a>, <a href="KllSketch.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNormalizedRankError(int,boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNumRetained()">getNumRetained</a>, <a href="KllSketch.html#getSerializedSizeBytes()">getSerializedSizeBytes</a>, <a href="KllSketch.html#hasMemory()">hasMemory</a>, <a href="KllSketch.html#isCompactMemoryFormat()">isCompactMemoryFormat</a>, <a href="KllSketch.html#isDirect()">isDirect</a>, <a href="KllSketch.html#isEmpty()">isEmpty</a>, <a href="KllSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="KllSketch.html#isMemoryUpdatableFormat()">isMemoryUpdatableFormat</a>, <a href="KllSketch.html#isReadOnly()">isReadOnly</a>, <a href="KllSketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="KllSketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a>, <a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a>, <a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a>, <a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesFloatsAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></h3> +<code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getMaxItem()">getMaxItem</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getMinItem()">getMinItem</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float)">getRank</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D)">getRanks</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getSerializedSizeBytes()">getSerializedSizeBytes</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newHeapInstance()"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span> <span class="element-name">newHeapInstance</span>()</div> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>new KllFloatsSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newHeapInstance(int)"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span> <span class="element-name">newHeapInstance</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>. + <em>k</em> can be between 8, inclusive, and 65535, inclusive. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> +<dt>Returns:</dt> +<dd>new KllFloatsSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>newDirectInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span> <span class="element-name">newDirectInstance</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger <em>k</em> will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>a new direct instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>newDirectInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span> <span class="element-name">newDirectInstance</span><wbr><span class="parameters">(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> +<dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>a new direct instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch. + The resulting sketch will not retain any link to the source Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a compact Memory image of a sketch serialized by this sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a heap-based sketch based on the given Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the read only source Memory</dd> +<dt>Returns:</dt> +<dd>instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>writableWrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span> <span class="element-name">writableWrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a WritableMemory that contains data.</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(float quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(float[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#iterator()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.kll.KllSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">KllSketch</a></code></span></div> +<div class="block">Merges another sketch into this one. + Attempting to merge a sketch of the wrong type will throw an exception.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">merge</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch to merge into this one</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p> + + <p>The parameter <i>k</i> will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#toByteArray()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean withLevels, + boolean withLevelsAndItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#toString(boolean,boolean)">KllSketch</a></code></span></div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#toString(boolean,boolean)">toString</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>withLevels</code> - if true includes sketch levels array summary information</dd> +<dd><code>withLevelsAndItems</code> - if true include detail of levels array and items array together</dd> +<dt>Returns:</dt> +<dd>human readable summary information about this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(float)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(float item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#update(float)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#update(float)">update</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of quantiles. NaNs are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(float,long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(float item, + long weight)</span></div> +<div class="block">Weighted update. Updates this sketch with the given item the number of times specified by the given integer weight.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be repeated. NaNs are ignored.</dd> +<dd><code>weight</code> - the number of times the update of item is to be repeated. It must be ≥ one.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(float[],int,int)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(float[] items, + int offset, + int length)</span></div> +<div class="block">Vector update. Updates this sketch with the given array (vector) of items, starting at the items + offset for a length number of items. This is not supported for direct sketches.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>items</code> - the vector of items</dd> +<dd><code>offset</code> - the starting index of the items[] array</dd> +<dd><code>length</code> - the number of items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSortedView()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllFloatsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/KllFloatsSketchIterator.html new file mode 100644 index 000000000..cde8d89a1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllFloatsSketchIterator.html @@ -0,0 +1,163 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllFloatsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllFloatsSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllFloatsSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllFloatsSketchIterator" class="title">Class KllFloatsSketchIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketchIterator</a> +<div class="inheritance">org.apache.datasketches.kll.KllFloatsSketchIterator</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code>, <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">KllFloatsSketchIterator</span> +<span class="extends-implements">extends <a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a> +implements <a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="block">Iterator over KllFloatsSketch. The order is not defined.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the float quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketchIterator">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></h3> +<code><a href="KllSketchIterator.html#getWeight()">getWeight</a>, <a href="KllSketchIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantile</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html#getQuantile()">QuantilesFloatsSketchIterator</a></code></span></div> +<div class="block">Gets the float quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html#getQuantile()">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the float quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllItemsSketch.html b/docs/7.0.X/org/apache/datasketches/kll/KllItemsSketch.html new file mode 100644 index 000000000..96f9d4ec7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllItemsSketch.html @@ -0,0 +1,914 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllItemsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllItemsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllItemsSketch" class="title">Class KllItemsSketch<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketch.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketch</a> +<div class="inheritance">org.apache.datasketches.kll.KllItemsSketch<T></div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type.</dd> +</dl> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T></code>, <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code>, <code><a href="../quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">KllItemsSketch<T></span> +<span class="extends-implements">extends <a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> +implements <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></span></div> +<div class="block">This variation of the KllSketch implements generic data types. The user must provide + a suitable implementation of the <i>java.lang.Comparator</i> as well as an implementation of + the serializer / deserializer, <i>org.apache.datasketches.common.ArrayOfItemsSerDe</i>.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="KllSketch.html" title="class in org.apache.datasketches.kll"><code>KllSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-org.apache.datasketches.kll.KllSketch">Nested classes/interfaces inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h2> +<code><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>, <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></code></div> +</section> +</li> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.kll.KllSketch">Fields inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#DEFAULT_K">DEFAULT_K</a>, <a href="KllSketch.html#MAX_K">MAX_K</a></code></div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComparator()" class="member-name-link">getComparator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Comparator of T</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a> quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Merges another sketch into this one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance(int,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance</a><wbr>(int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance(java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Export the current sketch as a compact byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean withLevels, + boolean withLevelsAndItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T,long)" class="member-name-link">update</a><wbr>(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a> item, + long weight)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Weighted update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Constructs a thin wrapper on the heap around a Memory (or WritableMemory) already initialized with a + validated sketch image of a type T consistent with the given comparator and serDe.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketch">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#getKFromEpsilon(double,boolean)">getKFromEpsilon</a>, <a href="KllSketch.html#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)">getMaxSerializedSizeBytes</a>, <a href="KllSketch.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNormalizedRankError(int,boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNumRetained()">getNumRetained</a>, <a href="KllSketch.html#getSerializedSizeBytes()">getSerializedSizeBytes</a>, <a href="KllSketch.html#hasMemory()">hasMemory</a>, <a href="KllSketch.html#isCompactMemoryFormat()">isCompactMemoryFormat</a>, <a href="KllSketch.html#isDirect()">isDirect</a>, <a href="KllSketch.html#isEmpty()">isEmpty</a>, <a href="KllSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="KllSketch.html#isMemoryUpdatableFormat()">isMemoryUpdatableFormat</a>, <a href="KllSketch.html#isReadOnly()">isReadOnly</a>, <a href="KllSketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="KllSketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.PartitioningFeature">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></h3> +<code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)">getPartitionBoundariesFromNumParts</a>, <a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)">getPartitionBoundariesFromPartSize</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a>, <a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a>, <a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a>, <a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesGenericAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></h3> +<code><a href="../quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getMaxItem()">getMaxItem</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getMaxPartitions()">getMaxPartitions</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getMinItem()">getMinItem</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getRank(T)">getRank</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D)">getRanks</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SketchPartitionLimits">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></h3> +<code><a href="../quantilescommon/SketchPartitionLimits.html#getMinPartitionSizeItems()">getMinPartitionSizeItems</a>, <a href="../quantilescommon/SketchPartitionLimits.html#getN()">getN</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newHeapInstance(java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></span> <span class="element-name">newHeapInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type.</dd> +<dt>Parameters:</dt> +<dd><code>comparator</code> - to compare items</dd> +<dd><code>serDe</code> - Serializer / deserializer for an array of items, <i>T[]</i>.</dd> +<dt>Returns:</dt> +<dd>new KllItemsSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newHeapInstance(int,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></span> <span class="element-name">newHeapInstance</span><wbr><span class="parameters">(int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>. + <em>k</em> can be between DEFAULT_M and 65535, inclusive. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> +<dd><code>comparator</code> - to compare items</dd> +<dd><code>serDe</code> - Serializer / deserializer for items of type <i>T</i> and <i>T[]</i>.</dd> +<dt>Returns:</dt> +<dd>new KllItemsSketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch. + The resulting sketch will not retain any link to the source Memory.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a compact Memory image of a sketch serialized by this sketch and of the same type of T.</dd> +<dd><code>comparator</code> - to compare items</dd> +<dd><code>serDe</code> - Serializer / deserializer for items of type <i>T</i> and <i>T[]</i>.</dd> +<dt>Returns:</dt> +<dd>a heap-based sketch based on the given Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Constructs a thin wrapper on the heap around a Memory (or WritableMemory) already initialized with a + validated sketch image of a type T consistent with the given comparator and serDe. + A reference to the Memory is kept in the sketch and must remain in scope consistent + with the temporal scope of this sketch. The amount of data kept on the heap is very small. + All of the item data originally collected by the given Memory sketch object remains in the + Memory object</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the Memory object that this sketch will wrap.</dd> +<dd><code>comparator</code> - to compare items</dd> +<dd><code>serDe</code> - Serializer / deserializer for items of type <i>T</i> and <i>T[]</i>.</dd> +<dt>Returns:</dt> +<dd>a heap-base sketch that is a thin wrapper around the given srcMem.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getCDF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></span> <span class="element-name">getClassOfT</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getClassOfT()">getClassOfT</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the sketch item class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getComparator()"> +<h3>getComparator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></span> <span class="element-name">getComparator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getComparator()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns the Comparator of T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getComparator()">getComparator</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>Comparator of the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromNumParts</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></span> <span class="element-name">getPartitionBoundariesFromNumParts</span><wbr><span class="parameters">(int numEquallySizedParts, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">PartitioningFeature</a></code></span></div> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromNumParts</a></code> in interface <code><a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>numEquallySizedParts</code> - an integer that specifies the number of equally sized partitions between + <a href="../quantilescommon/GenericPartitionBoundaries.html#getMinItem()"><code>getMinItem()</code></a> and + <a href="../quantilescommon/GenericPartitionBoundaries.html#getMaxItem()"><code>getMaxItem()</code></a>. + This must be a positive integer less than + <a href="../quantilescommon/SketchPartitionLimits.html#getMaxPartitions()"><code>getMaxPartitions()</code></a> + <ul> + <li>A 1 will return: minItem, maxItem.</li> + <li>A 2 will return: minItem, median quantile, maxItem.</li> + <li>Etc.</li> + </ul></dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromPartSize</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></span> <span class="element-name">getPartitionBoundariesFromPartSize</span><wbr><span class="parameters">(long nominalPartSizeItems, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">PartitioningFeature</a></code></span></div> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromPartSize</a></code> in interface <code><a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>nominalPartSizeItems</code> - an integer that specifies the nominal size, in items, of each target partition. + This must be a positive integer greater than + <a href="../quantilescommon/SketchPartitionLimits.html#getMinPartitionSizeItems()"><code>getMinPartitionSizeItems()</code></a>.</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getPMF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a></span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a></span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileLowerBound(double)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a></span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileUpperBound(double)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRank(java.lang.Object,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a> quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRanks(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></span> <span class="element-name">getSortedView</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getSortedView()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#iterator()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.kll.KllSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">KllSketch</a></code></span></div> +<div class="block">Merges another sketch into this one. + Attempting to merge a sketch of the wrong type will throw an exception.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">merge</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch to merge into this one</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#reset()">QuantilesAPI</a></code></span></div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Export the current sketch as a compact byte array.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current sketch as a compact byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean withLevels, + boolean withLevelsAndItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#toString(boolean,boolean)">KllSketch</a></code></span></div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#toString(boolean,boolean)">toString</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>withLevels</code> - if true includes sketch levels array summary information</dd> +<dd><code>withLevelsAndItems</code> - if true include detail of levels array and items array together</dd> +<dt>Returns:</dt> +<dd>human readable summary information about this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#update(T)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#update(T)">update</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of items. Nulls are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T,long)"> +<h3 id="update(java.lang.Object,long)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a> item, + long weight)</span></div> +<div class="block">Weighted update. Updates this sketch with the given item the number of times specified by the given integer weight.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be repeated. NaNs are ignored.</dd> +<dd><code>weight</code> - the number of times the update of item is to be repeated. It must be ≥ one.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllItemsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/KllItemsSketchIterator.html new file mode 100644 index 000000000..62b86e1d3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllItemsSketchIterator.html @@ -0,0 +1,167 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllItemsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllItemsSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllItemsSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllItemsSketchIterator" class="title">Class KllItemsSketchIterator<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketchIterator</a> +<div class="inheritance">org.apache.datasketches.kll.KllItemsSketchIterator<T></div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +</dl> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></code>, <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">KllItemsSketchIterator<T></span> +<span class="extends-implements">extends <a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a> +implements <a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></span></div> +<div class="block">Iterator over KllItemsSketch. The order is not defined.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KllItemsSketchIterator.html" title="type parameter in KllItemsSketchIterator">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the generic quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketchIterator">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></h3> +<code><a href="KllSketchIterator.html#getWeight()">getWeight</a>, <a href="KllSketchIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KllItemsSketchIterator.html" title="type parameter in KllItemsSketchIterator">T</a></span> <span class="element-name">getQuantile</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericSketchIterator.html#getQuantile()">QuantilesGenericSketchIterator</a></code></span></div> +<div class="block">Gets the generic quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericSketchIterator.html#getQuantile()">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="KllItemsSketchIterator.html" title="type parameter in KllItemsSketchIterator">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the generic quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllLongsSketch.html b/docs/7.0.X/org/apache/datasketches/kll/KllLongsSketch.html new file mode 100644 index 000000000..d97138206 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllLongsSketch.html @@ -0,0 +1,852 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllLongsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllLongsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllLongsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllLongsSketch" class="title">Class KllLongsSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketch.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketch</a> +<div class="inheritance">org.apache.datasketches.kll.KllLongsSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">KllLongsSketch</span> +<span class="extends-implements">extends <a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> +implements <a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></span></div> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="KllSketch.html" title="class in org.apache.datasketches.kll"><code>KllSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-org.apache.datasketches.kll.KllSketch">Nested classes/interfaces inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h2> +<code><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>, <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></code></div> +</section> +</li> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.kll.KllSketch">Fields inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#DEFAULT_K">DEFAULT_K</a>, <a href="KllSketch.html#MAX_K">MAX_K</a></code></div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(long[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(long[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(long[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Merges another sketch into this one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance()" class="member-name-link">newHeapInstance</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newHeapInstance(int)" class="member-name-link">newHeapInstance</a><wbr>(int k)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean withLevels, + boolean withLevelsAndItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D,int,int)" class="member-name-link">update</a><wbr>(long[] items, + int offset, + int length)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Vector update.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long,long)" class="member-name-link">update</a><wbr>(long item, + long weight)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Weighted update.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketch">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> +<code><a href="KllSketch.html#getKFromEpsilon(double,boolean)">getKFromEpsilon</a>, <a href="KllSketch.html#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)">getMaxSerializedSizeBytes</a>, <a href="KllSketch.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNormalizedRankError(int,boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNumRetained()">getNumRetained</a>, <a href="KllSketch.html#getSerializedSizeBytes()">getSerializedSizeBytes</a>, <a href="KllSketch.html#hasMemory()">hasMemory</a>, <a href="KllSketch.html#isCompactMemoryFormat()">isCompactMemoryFormat</a>, <a href="KllSketch.html#isDirect()">isDirect</a>, <a href="KllSketch.html#isEmpty()">isEmpty</a>, <a href="KllSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="KllSketch.html#isMemoryUpdatableFormat()">isMemoryUpdatableFormat</a>, <a href="KllSketch.html#isReadOnly()">isReadOnly</a>, <a href="KllSketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="KllSketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a>, <a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a>, <a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a>, <a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesLongsAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></h3> +<code><a href="../quantilescommon/QuantilesLongsAPI.html#getCDF(long%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getMaxItem()">getMaxItem</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getMinItem()">getMinItem</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getPMF(long%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getRank(long)">getRank</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getRanks(long%5B%5D)">getRanks</a>, <a href="../quantilescommon/QuantilesLongsAPI.html#getSerializedSizeBytes()">getSerializedSizeBytes</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newHeapInstance()"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span> <span class="element-name">newHeapInstance</span>()</div> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>new KllLongsSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newHeapInstance(int)"> +<h3>newHeapInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span> <span class="element-name">newHeapInstance</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>. + <em>k</em> can be between 8, inclusive, and 65535, inclusive. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> +<dt>Returns:</dt> +<dd>new KllLongsSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>newDirectInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span> <span class="element-name">newDirectInstance</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>. + The default <em>k</em> = 200 results in a normalized rank error of about + 1.65%. Larger <em>k</em> will have smaller error but the sketch will be larger (and slower).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>a new direct instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>newDirectInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span> <span class="element-name">newDirectInstance</span><wbr><span class="parameters">(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> +<dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>a new direct instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch. + The resulting sketch will not retain any link to the source Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a compact Memory image of a sketch serialized by this sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a heap-based sketch based on the given Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the read only source Memory</dd> +<dt>Returns:</dt> +<dd>instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>writableWrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span> <span class="element-name">writableWrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a WritableMemory that contains data.</dd> +<dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> +<dt>Returns:</dt> +<dd>instance of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(long[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesLongsAPI</a></code></span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(long[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesLongsAPI</a></code></span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesLongsAPI</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesLongsAPI</a></code></span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(long quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesLongsAPI</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(long[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesLongsAPI</a></code></span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#iterator()">QuantilesLongsAPI</a></code></span></div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.kll.KllSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">KllSketch</a></code></span></div> +<div class="block">Merges another sketch into this one. + Attempting to merge a sketch of the wrong type will throw an exception.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">merge</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch to merge into this one</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p> + + <p>The parameter <i>k</i> will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#toByteArray()">QuantilesLongsAPI</a></code></span></div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean withLevels, + boolean withLevelsAndItems)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="KllSketch.html#toString(boolean,boolean)">KllSketch</a></code></span></div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="KllSketch.html#toString(boolean,boolean)">toString</a></code> in class <code><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>withLevels</code> - if true includes sketch levels array summary information</dd> +<dd><code>withLevelsAndItems</code> - if true include detail of levels array and items array together</dd> +<dt>Returns:</dt> +<dd>human readable summary information about this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#update(long)">QuantilesLongsAPI</a></code></span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#update(long)">update</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of items. NaNs are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long,long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long item, + long weight)</span></div> +<div class="block">Weighted update. Updates this sketch with the given item the number of times specified by the given integer weight.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - the item to be repeated. NaNs are ignored.</dd> +<dd><code>weight</code> - the number of times the update of item is to be repeated. It must be ≥ one.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[],int,int)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] items, + int offset, + int length)</span></div> +<div class="block">Vector update. Updates this sketch with the given array (vector) of items, starting at the items + offset for a length number of items. This is not supported for direct sketches.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>items</code> - the vector of items</dd> +<dd><code>offset</code> - the starting index of the items[] array</dd> +<dd><code>length</code> - the number of items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsAPI.html#getSortedView()">QuantilesLongsAPI</a></code></span></div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllLongsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/KllLongsSketchIterator.html new file mode 100644 index 000000000..c6719b6e5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllLongsSketchIterator.html @@ -0,0 +1,163 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllLongsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllLongsSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllLongsSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllLongsSketchIterator" class="title">Class KllLongsSketchIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketchIterator</a> +<div class="inheritance">org.apache.datasketches.kll.KllLongsSketchIterator</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code>, <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">KllLongsSketchIterator</span> +<span class="extends-implements">extends <a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a> +implements <a href="../quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></span></div> +<div class="block">Iterator over KllLongsSketch. The order is not defined.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the long quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.kll.KllSketchIterator">Methods inherited from class org.apache.datasketches.kll.<a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></h3> +<code><a href="KllSketchIterator.html#getWeight()">getWeight</a>, <a href="KllSketchIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getQuantile</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesLongsSketchIterator.html#getQuantile()">QuantilesLongsSketchIterator</a></code></span></div> +<div class="block">Gets the long quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesLongsSketchIterator.html#getQuantile()">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the long quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllSketch.SketchStructure.html b/docs/7.0.X/org/apache/datasketches/kll/KllSketch.SketchStructure.html new file mode 100644 index 000000000..e3b678cd0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllSketch.SketchStructure.html @@ -0,0 +1,308 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllSketch.SketchStructure (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllSketch, enum: SketchStructure"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllSketch.SketchStructure.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Enum Class KllSketch.SketchStructure" class="title">Enum Class KllSketch.SketchStructure</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>> +<div class="inheritance">org.apache.datasketches.kll.KllSketch.SketchStructure</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">KllSketch.SketchStructure</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>></span></div> +<div class="block">Used primarily to define the structure of the serialized sketch. Also used by the Heap Sketch.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#COMPACT_EMPTY" class="member-name-link">COMPACT_EMPTY</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Compact Empty Structure</div> +</div> +<div class="col-first odd-row-color"><code><a href="#COMPACT_FULL" class="member-name-link">COMPACT_FULL</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Compact Full Preamble Structure</div> +</div> +<div class="col-first even-row-color"><code><a href="#COMPACT_SINGLE" class="member-name-link">COMPACT_SINGLE</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Compact Single Item Structure</div> +</div> +<div class="col-first odd-row-color"><code><a href="#UPDATABLE" class="member-name-link">UPDATABLE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Updatable Preamble Structure</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPreInts()" class="member-name-link">getPreInts</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">gets the Preamble Integers for this Structure.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerVer()" class="member-name-link">getSerVer</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">gets the Serialization Version for this Structure.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSketchStructure(int,int)" class="member-name-link">getSketchStructure</a><wbr>(int preInts, + int serVer)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">gets the SketchStructure given preInts and serVer.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="COMPACT_EMPTY"> +<h3>COMPACT_EMPTY</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span> <span class="element-name">COMPACT_EMPTY</span></div> +<div class="block">Compact Empty Structure</div> +</section> +</li> +<li> +<section class="detail" id="COMPACT_SINGLE"> +<h3>COMPACT_SINGLE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span> <span class="element-name">COMPACT_SINGLE</span></div> +<div class="block">Compact Single Item Structure</div> +</section> +</li> +<li> +<section class="detail" id="COMPACT_FULL"> +<h3>COMPACT_FULL</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span> <span class="element-name">COMPACT_FULL</span></div> +<div class="block">Compact Full Preamble Structure</div> +</section> +</li> +<li> +<section class="detail" id="UPDATABLE"> +<h3>UPDATABLE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span> <span class="element-name">UPDATABLE</span></div> +<div class="block">Updatable Preamble Structure</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPreInts()"> +<h3>getPreInts</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getPreInts</span>()</div> +<div class="block">gets the Preamble Integers for this Structure.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Preamble Integers for this Structure</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerVer()"> +<h3>getSerVer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSerVer</span>()</div> +<div class="block">gets the Serialization Version for this Structure.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Serialization Version for this Structure.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSketchStructure(int,int)"> +<h3>getSketchStructure</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span> <span class="element-name">getSketchStructure</span><wbr><span class="parameters">(int preInts, + int serVer)</span></div> +<div class="block">gets the SketchStructure given preInts and serVer.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>preInts</code> - the given preamble size in integers</dd> +<dd><code>serVer</code> - the given Serialization Version</dd> +<dt>Returns:</dt> +<dd>the SketchStructure given preInts and serVer.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllSketch.SketchType.html b/docs/7.0.X/org/apache/datasketches/kll/KllSketch.SketchType.html new file mode 100644 index 000000000..f87393240 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllSketch.SketchType.html @@ -0,0 +1,287 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllSketch.SketchType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllSketch, enum: SketchType"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllSketch.SketchType.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Enum Class KllSketch.SketchType" class="title">Enum Class KllSketch.SketchType</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a>> +<div class="inheritance">org.apache.datasketches.kll.KllSketch.SketchType</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">KllSketch.SketchType</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a>></span></div> +<div class="block">Used to define the variable type of the current instance of this class.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#DOUBLES_SKETCH" class="member-name-link">DOUBLES_SKETCH</a></code></div> +<div class="col-last even-row-color"> +<div class="block">KllDoublesSketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="#FLOATS_SKETCH" class="member-name-link">FLOATS_SKETCH</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">KllFloatsSketch</div> +</div> +<div class="col-first even-row-color"><code><a href="#ITEMS_SKETCH" class="member-name-link">ITEMS_SKETCH</a></code></div> +<div class="col-last even-row-color"> +<div class="block">KllItemsSketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="#LONGS_SKETCH" class="member-name-link">LONGS_SKETCH</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">KllDoublesSketch</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBytes()" class="member-name-link">getBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the item size in bytes.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get the name of the associated sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DOUBLES_SKETCH"> +<h3>DOUBLES_SKETCH</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span> <span class="element-name">DOUBLES_SKETCH</span></div> +<div class="block">KllDoublesSketch</div> +</section> +</li> +<li> +<section class="detail" id="FLOATS_SKETCH"> +<h3>FLOATS_SKETCH</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span> <span class="element-name">FLOATS_SKETCH</span></div> +<div class="block">KllFloatsSketch</div> +</section> +</li> +<li> +<section class="detail" id="ITEMS_SKETCH"> +<h3>ITEMS_SKETCH</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span> <span class="element-name">ITEMS_SKETCH</span></div> +<div class="block">KllItemsSketch</div> +</section> +</li> +<li> +<section class="detail" id="LONGS_SKETCH"> +<h3>LONGS_SKETCH</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span> <span class="element-name">LONGS_SKETCH</span></div> +<div class="block">KllDoublesSketch</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getBytes()"> +<h3>getBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBytes</span>()</div> +<div class="block">Gets the item size in bytes. If the item is generic, this returns zero.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the item size in bytes</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getName()"> +<h3>getName</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getName</span>()</div> +<div class="block">Get the name of the associated sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the name of the associated sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllSketch.html b/docs/7.0.X/org/apache/datasketches/kll/KllSketch.html new file mode 100644 index 000000000..a1b6dc885 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllSketch.html @@ -0,0 +1,592 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllSketch" class="title">Class KllSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.kll.KllSketch</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code>, <code><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code>, <code><a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></code>, <code><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">KllSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="block">This class is the root of the KLL sketch class hierarchy. It includes the public API that is independent + of either sketch type (e.g., float, double or generic item) and independent of whether the sketch is targeted + for use on the Java heap or off-heap. + + <p>KLL is an implementation of a very compact quantiles sketch with lazy compaction scheme + and nearly optimal accuracy per retained quantile.</p> + + <p>Reference <a href="https://arxiv.org/abs/1603.05346v2">Optimal Quantile Approximation in Streams</a>.</p> + + <p>The default <i>k</i> of 200 yields a "single-sided" epsilon of about 1.33% and a + "double-sided" (PMF) epsilon of about 1.65%, with a confidence of 99%.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang, Alexander Saydakov</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="https://datasketches.apache.org/docs/KLL/KLLSketch.html">KLL Sketch</a></li> +<li><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="KllSketch.SketchStructure.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Used primarily to define the structure of the serialized sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static enum </code></div> +<div class="col-second odd-row-color"><code><a href="KllSketch.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Used to define the variable type of the current instance of this class.</div> +</div> +</div> +</section> +</li> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final int</code></div> +<div class="col-second even-row-color"><code><a href="#DEFAULT_K" class="member-name-link">DEFAULT_K</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The default K</div> +</div> +<div class="col-first odd-row-color"><code>static final int</code></div> +<div class="col-second odd-row-color"><code><a href="#MAX_K" class="member-name-link">MAX_K</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The maximum K</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon</a><wbr>(double epsilon, + boolean pmf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)" class="member-name-link">getMaxSerializedSizeBytes</a><wbr>(int k, + long n, + <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a> sketchType, + boolean updatableMemFormat)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns upper bound on the serialized size of a KllSketch given the following parameters.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(boolean pmf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(int k, + boolean pmf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the normalized rank error given k and pmf.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of bytes this Sketch would require if serialized in compact form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCompactMemoryFormat()" class="member-name-link">isCompactMemoryFormat</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is in a Compact Memory Format.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is empty.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is in estimation mode.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMemoryUpdatableFormat()" class="member-name-link">isMemoryUpdatableFormat</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the backing WritableMemory is in updatable format.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is read only.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource</a><wbr>(org.apache.datasketches.memory.Memory that)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Merges another sketch into this one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a summary of the key parameters of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean withLevels, + boolean withLevelsAndItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a>, <a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a>, <a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a>, <a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a>, <a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DEFAULT_K"> +<h3>DEFAULT_K</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_K</span></div> +<div class="block">The default K</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.kll.KllSketch.DEFAULT_K">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="MAX_K"> +<h3>MAX_K</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">MAX_K</span></div> +<div class="block">The maximum K</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.kll.KllSketch.MAX_K">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getKFromEpsilon(double,boolean)"> +<h3>getKFromEpsilon</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getKFromEpsilon</span><wbr><span class="parameters">(double epsilon, + boolean pmf)</span></div> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>epsilon</code> - the normalized rank error between zero and one.</dd> +<dd><code>pmf</code> - if true, this function returns the <em>k</em> assuming the input epsilon + is the desired "double-sided" epsilon for the getPMF() function. Otherwise, this function + returns <em>k</em> assuming the input epsilon is the desired "single-sided" + epsilon for all the other queries.</dd> +<dt>Returns:</dt> +<dd><i>k</i> given epsilon.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)"> +<h3>getMaxSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxSerializedSizeBytes</span><wbr><span class="parameters">(int k, + long n, + <a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a> sketchType, + boolean updatableMemFormat)</span></div> +<div class="block">Returns upper bound on the serialized size of a KllSketch given the following parameters.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates</dd> +<dd><code>n</code> - stream length</dd> +<dd><code>sketchType</code> - Only DOUBLES_SKETCH and FLOATS_SKETCH is supported for this operation.</dd> +<dd><code>updatableMemFormat</code> - true if updatable Memory format, otherwise the standard compact format.</dd> +<dt>Returns:</dt> +<dd>upper bound on the serialized size of a KllSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(int,boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(int k, + boolean pmf)</span></div> +<div class="block">Gets the normalized rank error given k and pmf. + Static method version of the <i>getNormalizedRankError(boolean)</i>. + The epsilon returned is a best fit to 99 percent confidence empirically measured max error + in thousands of trials.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - the configuration parameter</dd> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, the normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(boolean pmf)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">QuantilesAPI</a></code></span></div> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one. + The epsilon returned is a best fit to 99 percent confidence empirically measured max error + in thousands of trials.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes()"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span>()</div> +<div class="block">Returns the current number of bytes this Sketch would require if serialized in compact form.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of bytes this sketch would require if serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isCompactMemoryFormat()"> +<h3>isCompactMemoryFormat</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCompactMemoryFormat</span>()</div> +<div class="block">Returns true if this sketch is in a Compact Memory Format.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is in a Compact Memory Format.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is in estimation mode.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isMemoryUpdatableFormat()"> +<h3>isMemoryUpdatableFormat</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isMemoryUpdatableFormat</span>()</div> +<div class="block">Returns true if the backing WritableMemory is in updatable format.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the backing WritableMemory is in updatable format.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is read only.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is read only.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isSameResource(org.apache.datasketches.memory.Memory)"> +<h3>isSameResource</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isSameResource</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory that)</span></div> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>. The capacities must be the same. If <i>this</i> is a region, + the region offset must also be the same.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>that</code> - A different non-null object</dd> +<dt>Returns:</dt> +<dd>true if the backing resource of <i>this</i> is the same as the backing resource + of <i>that</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.kll.KllSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</span></div> +<div class="block">Merges another sketch into this one. + Attempting to merge a sketch of the wrong type will throw an exception.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch to merge into this one</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#toString()">QuantilesAPI</a></code></span></div> +<div class="block">Returns a summary of the key parameters of the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>a summary of the key parameters of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean withLevels, + boolean withLevelsAndItems)</span></div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>withLevels</code> - if true includes sketch levels array summary information</dd> +<dd><code>withLevelsAndItems</code> - if true include detail of levels array and items array together</dd> +<dt>Returns:</dt> +<dd>human readable summary information about this sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/KllSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/KllSketchIterator.html new file mode 100644 index 000000000..4ae79fb74 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/KllSketchIterator.html @@ -0,0 +1,192 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KllSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll, class: KllSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KllSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> +<h1 title="Class KllSketchIterator" class="title">Class KllSketchIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.kll.KllSketchIterator</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></code>, <code><a href="KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></code>, <code><a href="KllItemsSketchIterator.html" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a></code>, <code><a href="KllLongsSketchIterator.html" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">KllSketchIterator</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="block">The base implementation for the KLL sketch iterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch. + + <p>Prototype example of the recommended iteration loop:</p> + <pre><code> + SketchIterator itr = sketch.iterator(); + while (itr.next()) { + ...get*(); + } + </code></pre></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWeight()" class="member-name-link">getWeight</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the natural weight at the current index.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Advances the index and checks if it is valid.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getWeight()"> +<h3>getWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getWeight</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Gets the natural weight at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the natural weight at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Advances the index and checks if it is valid. + The state of this iterator is undefined before the first call of this method.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>true if the next index is valid.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllDoublesSketch.html new file mode 100644 index 000000000..3053a4c96 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllDoublesSketch.html @@ -0,0 +1,128 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllDoublesSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllDoublesSketch" class="title">Uses of Class<br>org.apache.datasketches.kll.KllDoublesSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> that return <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#newHeapInstance()" class="member-name-link">newHeapInstance</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#newHeapInstance(int)" class="member-name-link">newHeapInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllDoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllDoublesSketchIterator.html new file mode 100644 index 000000000..3c6921e3d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllDoublesSketchIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllDoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllDoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllDoublesSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.kll.KllDoublesSketchIterator</h1> +</div> +No usage of org.apache.datasketches.kll.KllDoublesSketchIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllFloatsSketch.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllFloatsSketch.html new file mode 100644 index 000000000..5cb33ec77 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllFloatsSketch.html @@ -0,0 +1,128 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllFloatsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllFloatsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllFloatsSketch" class="title">Uses of Class<br>org.apache.datasketches.kll.KllFloatsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> that return <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#newHeapInstance()" class="member-name-link">newHeapInstance</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#newHeapInstance(int)" class="member-name-link">newHeapInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllFloatsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllFloatsSketchIterator.html new file mode 100644 index 000000000..effa5b94b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllFloatsSketchIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllFloatsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllFloatsSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllFloatsSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.kll.KllFloatsSketchIterator</h1> +</div> +No usage of org.apache.datasketches.kll.KllFloatsSketchIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllItemsSketch.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllItemsSketch.html new file mode 100644 index 000000000..7ad4ab6ce --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllItemsSketch.html @@ -0,0 +1,115 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllItemsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllItemsSketch" class="title">Uses of Class<br>org.apache.datasketches.kll.KllItemsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> that return <a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../KllItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../KllItemsSketch.html#newHeapInstance(int,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance</a><wbr>(int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../KllItemsSketch.html#newHeapInstance(java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">newHeapInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../KllItemsSketch.html#wrap(org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs a thin wrapper on the heap around a Memory (or WritableMemory) already initialized with a + validated sketch image of a type T consistent with the given comparator and serDe.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllItemsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllItemsSketchIterator.html new file mode 100644 index 000000000..e3d74f0bc --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllItemsSketchIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllItemsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllItemsSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllItemsSketchIterator.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllItemsSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.kll.KllItemsSketchIterator</h1> +</div> +No usage of org.apache.datasketches.kll.KllItemsSketchIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllLongsSketch.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllLongsSketch.html new file mode 100644 index 000000000..94a49b370 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllLongsSketch.html @@ -0,0 +1,128 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllLongsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllLongsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllLongsSketch" class="title">Uses of Class<br>org.apache.datasketches.kll.KllLongsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> that return <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(int k, + org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new direct updatable instance of this sketch with a given <em>k</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">newDirectInstance</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new direct updatable instance of this sketch with the default <em>k</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#newHeapInstance()" class="member-name-link">newHeapInstance</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#newHeapInstance(int)" class="member-name-link">newHeapInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap a sketch around the given read only compact source Memory containing sketch data + that originated from this sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">writableWrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap a sketch around the given source Writable Memory containing sketch data + that originated from this sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllLongsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllLongsSketchIterator.html new file mode 100644 index 000000000..4209a35d9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllLongsSketchIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllLongsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllLongsSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllLongsSketchIterator.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllLongsSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.kll.KllLongsSketchIterator</h1> +</div> +No usage of org.apache.datasketches.kll.KllLongsSketchIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.SketchStructure.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.SketchStructure.html new file mode 100644 index 000000000..6432a5b57 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.SketchStructure.html @@ -0,0 +1,104 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.kll.KllSketch.SketchStructure (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllSketch, enum: SketchStructure"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.kll.KllSketch.SketchStructure" class="title">Uses of Enum Class<br>org.apache.datasketches.kll.KllSketch.SketchStructure</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> that return <a href="../KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllSketch.SketchStructure.</span><code><a href="../KllSketch.SketchStructure.html#getSketchStructure(int,int)" class="member-name-link">getSketchStructure</a><wbr>(int preInts, + int serVer)</code></div> +<div class="col-last even-row-color"> +<div class="block">gets the SketchStructure given preInts and serVer.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllSketch.SketchStructure.</span><code><a href="../KllSketch.SketchStructure.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllSketch.SketchStructure.</span><code><a href="../KllSketch.SketchStructure.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.SketchType.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.SketchType.html new file mode 100644 index 000000000..9d08bb72d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.SketchType.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.kll.KllSketch.SketchType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllSketch, enum: SketchType"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.kll.KllSketch.SketchType" class="title">Uses of Enum Class<br>org.apache.datasketches.kll.KllSketch.SketchType</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> that return <a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllSketch.SketchType.</span><code><a href="../KllSketch.SketchType.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllSketch.SketchType.</span><code><a href="../KllSketch.SketchType.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> with parameters of type <a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllSketch.</span><code><a href="../KllSketch.html#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)" class="member-name-link">getMaxSerializedSizeBytes</a><wbr>(int k, + long n, + <a href="../KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a> sketchType, + boolean updatableMemFormat)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns upper bound on the serialized size of a KllSketch given the following parameters.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.html new file mode 100644 index 000000000..dc37e5489 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketch.html @@ -0,0 +1,130 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllSketch.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllSketch" class="title">Uses of Class<br>org.apache.datasketches.kll.KllSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Subclasses of <a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../KllDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../KllFloatsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../KllLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.kll</a> with parameters of type <a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../KllDoublesSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>final void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../KllFloatsSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>final void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../KllItemsSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>final void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../KllLongsSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>abstract void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllSketch.</span><code><a href="../KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)" class="member-name-link">merge</a><wbr>(<a href="../KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">Merges another sketch into this one.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketchIterator.html b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketchIterator.html new file mode 100644 index 000000000..989e737a3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/class-use/KllSketchIterator.html @@ -0,0 +1,107 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.kll.KllSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll, class: KllSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KllSketchIterator.html" title="class in org.apache.datasketches.kll">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.kll.KllSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.kll.KllSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Subclasses of <a href="../KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.kll</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../KllDoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllDoublesSketch.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../KllFloatsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over KllFloatsSketch.</div> +</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../KllItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllItemsSketch.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../KllLongsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over KllLongsSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/package-summary.html b/docs/7.0.X/org/apache/datasketches/kll/package-summary.html new file mode 100644 index 000000000..d9f32cb76 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/package-summary.html @@ -0,0 +1,157 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.kll (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.kll"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.kll" class="title">Package org.apache.datasketches.kll</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.kll</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over KllDoublesSketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over KllFloatsSketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KllItemsSketchIterator.html" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over KllItemsSketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KllLongsSketchIterator.html" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over KllLongsSketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This class is the root of the KLL sketch class hierarchy.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="KllSketch.SketchStructure.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block">Used primarily to define the structure of the serialized sketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="KllSketch.SketchType.html" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">Used to define the variable type of the current instance of this class.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">The base implementation for the KLL sketch iterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/package-tree.html b/docs/7.0.X/org/apache/datasketches/kll/package-tree.html new file mode 100644 index 000000000..8f68194f3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/package-tree.html @@ -0,0 +1,106 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.kll Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.kll"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.kll</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.kll.<a href="KllSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a>) +<ul> +<li class="circle">org.apache.datasketches.kll.<a href="KllDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="KllFloatsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="KllLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a>)</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.kll.<a href="KllSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a>) +<ul> +<li class="circle">org.apache.datasketches.kll.<a href="KllDoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="KllFloatsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="KllItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><T> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="KllLongsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a>)</li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.kll.<a href="KllSketch.SketchStructure.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></li> +<li class="circle">org.apache.datasketches.kll.<a href="KllSketch.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/kll/package-use.html b/docs/7.0.X/org/apache/datasketches/kll/package-use.html new file mode 100644 index 000000000..405862979 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/kll/package-use.html @@ -0,0 +1,118 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.kll (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.kll"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.kll" class="title">Uses of Package<br>org.apache.datasketches.kll</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.kll</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.kll</a> used by <a href="package-summary.html">org.apache.datasketches.kll</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/KllDoublesSketch.html#org.apache.datasketches.kll">KllDoublesSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/KllFloatsSketch.html#org.apache.datasketches.kll">KllFloatsSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/KllItemsSketch.html#org.apache.datasketches.kll">KllItemsSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/KllLongsSketch.html#org.apache.datasketches.kll">KllLongsSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/KllSketch.html#org.apache.datasketches.kll">KllSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">This class is the root of the KLL sketch class hierarchy.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/KllSketch.SketchStructure.html#org.apache.datasketches.kll">KllSketch.SketchStructure</a></div> +<div class="col-last odd-row-color"> +<div class="block">Used primarily to define the structure of the serialized sketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/KllSketch.SketchType.html#org.apache.datasketches.kll">KllSketch.SketchType</a></div> +<div class="col-last even-row-color"> +<div class="block">Used to define the variable type of the current instance of this class.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/KllSketchIterator.html#org.apache.datasketches.kll">KllSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The base implementation for the KLL sketch iterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/package-summary.html b/docs/7.0.X/org/apache/datasketches/package-summary.html new file mode 100644 index 000000000..41f8e6abf --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/package-summary.html @@ -0,0 +1,174 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li>Classes and Interfaces</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches" class="title">Package org.apache.datasketches</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="common/package-summary.html">org.apache.datasketches.common</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for common classes that may be used across all the sketch families.</div> +</div> +<div class="col-first odd-row-color"><a href="cpc/package-summary.html">org.apache.datasketches.cpc</a></div> +<div class="col-last odd-row-color"> +<div class="block">Compressed Probabilistic Counting sketch family</div> +</div> +<div class="col-first even-row-color"><a href="fdt/package-summary.html">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first odd-row-color"><a href="filters/package-summary.html">org.apache.datasketches.filters</a></div> +<div class="col-last odd-row-color"> +<div class="block">The filters package contains data structures used to determine + approximate set-membership.</div> +</div> +<div class="col-first even-row-color"><a href="frequencies/package-summary.html">org.apache.datasketches.frequencies</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable estimation of the + frequency of occurrence of items in a weighted multiset stream of items.</div> +</div> +<div class="col-first odd-row-color"><a href="hash/package-summary.html">org.apache.datasketches.hash</a></div> +<div class="col-last odd-row-color"> +<div class="block">The hash package contains a high-performing and extended Java implementations + of Austin Appleby's 128-bit MurmurHash3 hash function originally coded in C.</div> +</div> +<div class="col-first even-row-color"><a href="hll/package-summary.html">org.apache.datasketches.hll</a></div> +<div class="col-last even-row-color"> +<div class="block">The DataSketches™ HLL sketch family package</div> +</div> +<div class="col-first odd-row-color"><a href="hllmap/package-summary.html">org.apache.datasketches.hllmap</a></div> +<div class="col-last odd-row-color"> +<div class="block">The hllmap package contains a space efficient HLL mapping sketch of keys to approximate unique + count of identifiers.</div> +</div> +<div class="col-first even-row-color"><a href="kll/package-summary.html">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="partitions/package-summary.html">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><a href="quantiles/package-summary.html">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="req/package-summary.html">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +<div class="col-first odd-row-color"><a href="sampling/package-summary.html">org.apache.datasketches.sampling</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +<div class="col-first even-row-color"><a href="tdigest/package-summary.html">org.apache.datasketches.tdigest</a></div> +<div class="col-last even-row-color"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +<div class="col-first odd-row-color"><a href="theta/package-summary.html">org.apache.datasketches.theta</a></div> +<div class="col-last odd-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first even-row-color"><a href="thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first odd-row-color"><a href="tuple/package-summary.html">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/package-tree.html b/docs/7.0.X/org/apache/datasketches/package-tree.html new file mode 100644 index 000000000..cd0931a19 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/package-tree.html @@ -0,0 +1,66 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/package-use.html b/docs/7.0.X/org/apache/datasketches/package-use.html new file mode 100644 index 000000000..7a2267ea2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/package-use.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches" class="title">Uses of Package<br>org.apache.datasketches</h1> +</div> +No usage of org.apache.datasketches</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/BoundsRule.html b/docs/7.0.X/org/apache/datasketches/partitions/BoundsRule.html new file mode 100644 index 000000000..7af453b68 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/BoundsRule.html @@ -0,0 +1,252 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BoundsRule (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.partitions, enum: BoundsRule"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BoundsRule.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.partitions</a></div> +<h1 title="Enum Class BoundsRule" class="title">Enum Class BoundsRule</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a>> +<div class="inheritance">org.apache.datasketches.partitions.BoundsRule</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">BoundsRule</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a>></span></div> +<div class="block">This instructs the user about which of the upper and lower bounds of a partition definition row + should be included with the returned data.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#INCLUDE_BOTH" class="member-name-link">INCLUDE_BOTH</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Include both the upper and lower bounds</div> +</div> +<div class="col-first odd-row-color"><code><a href="#INCLUDE_LOWER" class="member-name-link">INCLUDE_LOWER</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Include only the lower bound but not the upper bound</div> +</div> +<div class="col-first even-row-color"><code><a href="#INCLUDE_NEITHER" class="member-name-link">INCLUDE_NEITHER</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Include none</div> +</div> +<div class="col-first odd-row-color"><code><a href="#INCLUDE_UPPER" class="member-name-link">INCLUDE_UPPER</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Include only the upper bound but not the lower bound</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="INCLUDE_BOTH"> +<h3>INCLUDE_BOTH</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span> <span class="element-name">INCLUDE_BOTH</span></div> +<div class="block">Include both the upper and lower bounds</div> +</section> +</li> +<li> +<section class="detail" id="INCLUDE_UPPER"> +<h3>INCLUDE_UPPER</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span> <span class="element-name">INCLUDE_UPPER</span></div> +<div class="block">Include only the upper bound but not the lower bound</div> +</section> +</li> +<li> +<section class="detail" id="INCLUDE_LOWER"> +<h3>INCLUDE_LOWER</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span> <span class="element-name">INCLUDE_LOWER</span></div> +<div class="block">Include only the lower bound but not the upper bound</div> +</section> +</li> +<li> +<section class="detail" id="INCLUDE_NEITHER"> +<h3>INCLUDE_NEITHER</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span> <span class="element-name">INCLUDE_NEITHER</span></div> +<div class="block">Include none</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html b/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html new file mode 100644 index 000000000..3d41385d6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html @@ -0,0 +1,240 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Partitioner.PartitionBoundsRow (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.partitions, class: Partitioner, class: PartitionBoundsRow"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Partitioner.PartitionBoundsRow.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.partitions</a></div> +<h1 title="Class Partitioner.PartitionBoundsRow" class="title">Class Partitioner.PartitionBoundsRow<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.partitions.Partitioner.PartitionBoundsRow<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="Partitioner.html" title="type parameter in Partitioner">S</a> extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>>></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">Partitioner.PartitionBoundsRow<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Defines a row for List of PartitionBounds.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>long</code></div> +<div class="col-second even-row-color"><code><a href="#approxNumDeltaItems" class="member-name-link">approxNumDeltaItems</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The approximate number of items represented by this partition description row.</div> +</div> +<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#levelPartId" class="member-name-link">levelPartId</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A brief string description of the partition and its hierarchy</div> +</div> +<div class="col-first even-row-color"><code><a href="Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a></code></div> +<div class="col-second even-row-color"><code><a href="#lowerBound" class="member-name-link">lowerBound</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The lower bound value</div> +</div> +<div class="col-first odd-row-color"><code>int</code></div> +<div class="col-second odd-row-color"><code><a href="#part" class="member-name-link">part</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The partition index</div> +</div> +<div class="col-first even-row-color"><code><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></code></div> +<div class="col-second even-row-color"><code><a href="#rule" class="member-name-link">rule</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The BoundsRule for this partition description row.</div> +</div> +<div class="col-first odd-row-color"><code><a href="Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a></code></div> +<div class="col-second odd-row-color"><code><a href="#upperBound" class="member-name-link">upperBound</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The upper bound value</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.partitions.Partitioner.StackElement)" class="member-name-link">PartitionBoundsRow</a><wbr>(<a href="Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><<a href="Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a>> se)</code></div> +<div class="col-last even-row-color"> +<div class="block">The constructor for the StackElement class.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="part"> +<h3>part</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">part</span></div> +<div class="block">The partition index</div> +</section> +</li> +<li> +<section class="detail" id="levelPartId"> +<h3>levelPartId</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">levelPartId</span></div> +<div class="block">A brief string description of the partition and its hierarchy</div> +</section> +</li> +<li> +<section class="detail" id="approxNumDeltaItems"> +<h3>approxNumDeltaItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">approxNumDeltaItems</span></div> +<div class="block">The approximate number of items represented by this partition description row.</div> +</section> +</li> +<li> +<section class="detail" id="rule"> +<h3>rule</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span> <span class="element-name">rule</span></div> +<div class="block">The BoundsRule for this partition description row.</div> +</section> +</li> +<li> +<section class="detail" id="lowerBound"> +<h3>lowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a></span> <span class="element-name">lowerBound</span></div> +<div class="block">The lower bound value</div> +</section> +</li> +<li> +<section class="detail" id="upperBound"> +<h3>upperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a></span> <span class="element-name">upperBound</span></div> +<div class="block">The upper bound value</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.partitions.Partitioner.StackElement)"> +<h3>PartitionBoundsRow</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PartitionBoundsRow</span><wbr><span class="parameters">(<a href="Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><<a href="Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a>> se)</span></div> +<div class="block">The constructor for the StackElement class.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>se</code> - the given stack element.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.StackElement.html b/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.StackElement.html new file mode 100644 index 000000000..314f99696 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.StackElement.html @@ -0,0 +1,210 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Partitioner.StackElement (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.partitions, class: Partitioner, class: StackElement"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Partitioner.StackElement.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.partitions</a></div> +<h1 title="Class Partitioner.StackElement" class="title">Class Partitioner.StackElement<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.partitions.Partitioner.StackElement<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="Partitioner.html" title="type parameter in Partitioner">S</a> extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>>></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">Partitioner.StackElement<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Holds data for a Stack element</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>></code></div> +<div class="col-second even-row-color"><code><a href="#gpb" class="member-name-link">gpb</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A reference to the relevant GenericPartitionBoundaries class</div> +</div> +<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#levelPartId" class="member-name-link">levelPartId</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A brief string description of the partition and its hierarchy</div> +</div> +<div class="col-first even-row-color"><code>int</code></div> +<div class="col-second even-row-color"><code><a href="#part" class="member-name-link">part</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The partition index</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.quantilescommon.GenericPartitionBoundaries,int,java.lang.String)" class="member-name-link">StackElement</a><wbr>(<a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>> gpb, + int part, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> levelPartId)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs this StackElement</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="gpb"> +<h3>gpb</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>></span> <span class="element-name">gpb</span></div> +<div class="block">A reference to the relevant GenericPartitionBoundaries class</div> +</section> +</li> +<li> +<section class="detail" id="part"> +<h3>part</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">part</span></div> +<div class="block">The partition index</div> +</section> +</li> +<li> +<section class="detail" id="levelPartId"> +<h3>levelPartId</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">levelPartId</span></div> +<div class="block">A brief string description of the partition and its hierarchy</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.quantilescommon.GenericPartitionBoundaries,int,java.lang.String)"> +<h3>StackElement</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StackElement</span><wbr><span class="parameters">(<a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>> gpb, + int part, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> levelPartId)</span></div> +<div class="block">Constructs this StackElement</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>gpb</code> - the given GenericPartitionBoundarie reference</dd> +<dd><code>part</code> - The partition index</dd> +<dd><code>levelPartId</code> - A brief string description of the partition and its hierarchy</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.html b/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.html new file mode 100644 index 000000000..300eec16f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/Partitioner.html @@ -0,0 +1,249 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Partitioner (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.partitions, class: Partitioner"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Partitioner.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.partitions</a></div> +<h1 title="Class Partitioner" class="title">Class Partitioner<T,<wbr>S extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.partitions.Partitioner<T,<wbr>S></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the data type</dd> +<dd><code>S</code> - the quantiles sketch that implements both QuantilesGenericAPI and PartitioningFeature.</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Partitioner<T,<wbr>S extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A partitioning process that can partition very large data sets into thousands + of partitions of approximately the same size. + + <p>The code included here does work fine for moderate sized partitioning tasks. + As an example, using the test code in the test branch with the partitioning task of splitting + a data set of 1 billion items into 324 partitions of size 3M items completed in under 3 minutes, which was + performed on a single CPU. For much larger partitioning tasks, it is recommended that this code be leveraged into a + parallelized systems environment.</p></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static class </code></div> +<div class="col-second even-row-color"><code><a href="Partitioner.PartitionBoundsRow.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><<a href="Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">Defines a row for List of PartitionBounds.</div> +</div> +<div class="col-first odd-row-color"><code>static class </code></div> +<div class="col-second odd-row-color"><code><a href="Partitioner.StackElement.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><<a href="Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>></code></div> +<div class="col-last odd-row-color"> +<div class="block">Holds data for a Stack element</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest)" class="member-name-link">Partitioner</a><wbr>(long tgtPartitionSize, + int maxPartsPerPass, + <a href="SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="Partitioner.html" title="type parameter in Partitioner">S</a>> fillReq)</code></div> +<div class="col-last even-row-color"> +<div class="block">This constructor assumes a QuantileSearchCriteria of INCLUSIVE.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">Partitioner</a><wbr>(long tgtPartitionSize, + int maxPartsPerSk, + <a href="SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="Partitioner.html" title="type parameter in Partitioner">S</a>> fillReq, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> criteria)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This constructor includes the QuantileSearchCriteria criteria as a parameter.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#partition(S)" class="member-name-link">partition</a><wbr>(<a href="Partitioner.html" title="type parameter in Partitioner">S</a> sk)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This initiates the partitioning process</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(long,int,org.apache.datasketches.partitions.SketchFillRequest)"> +<h3>Partitioner</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Partitioner</span><wbr><span class="parameters">(long tgtPartitionSize, + int maxPartsPerPass, + <a href="SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="Partitioner.html" title="type parameter in Partitioner">S</a>> fillReq)</span></div> +<div class="block">This constructor assumes a QuantileSearchCriteria of INCLUSIVE.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tgtPartitionSize</code> - the target size of the resulting partitions in number of items.</dd> +<dd><code>maxPartsPerPass</code> - The maximum number of partitions to request from the sketch. The smaller this number is + the smaller the variance will be of the resulting partitions, but this will increase the number of passes of the + source data set.</dd> +<dd><code>fillReq</code> - The is an implementation of the SketchFillRequest call-back supplied by the user and implements + the SketchFillRequest interface.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(long,int,org.apache.datasketches.partitions.SketchFillRequest,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>Partitioner</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Partitioner</span><wbr><span class="parameters">(long tgtPartitionSize, + int maxPartsPerSk, + <a href="SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="Partitioner.html" title="type parameter in Partitioner">S</a>> fillReq, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> criteria)</span></div> +<div class="block">This constructor includes the QuantileSearchCriteria criteria as a parameter.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tgtPartitionSize</code> - the target size of the resulting partitions in number of items.</dd> +<dd><code>maxPartsPerSk</code> - The maximum number of partitions to request from the sketch. The smaller this number is + the smaller the variance will be of the resulting partitions, but this will increase the number of passes of the + source data set.</dd> +<dd><code>fillReq</code> - The is an implementation of the SketchFillRequest call-back supplied by the user.</dd> +<dd><code>criteria</code> - This is the desired QuantileSearchCriteria to be used.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="partition(S)"> +<h3 id="partition(org.apache.datasketches.quantilescommon.QuantilesGenericAPI)">partition</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><<a href="Partitioner.html" title="type parameter in Partitioner">T</a>>></span> <span class="element-name">partition</span><wbr><span class="parameters">(<a href="Partitioner.html" title="type parameter in Partitioner">S</a> sk)</span></div> +<div class="block">This initiates the partitioning process</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sk</code> - A sketch of the entire data set.</dd> +<dt>Returns:</dt> +<dd>the final partitioning list</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/SketchFillRequest.html b/docs/7.0.X/org/apache/datasketches/partitions/SketchFillRequest.html new file mode 100644 index 000000000..f61300846 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/SketchFillRequest.html @@ -0,0 +1,160 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SketchFillRequest (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.partitions, interface: SketchFillRequest"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SketchFillRequest.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.partitions</a></div> +<h1 title="Interface SketchFillRequest" class="title">Interface SketchFillRequest<T,<wbr>S extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +<dd><code>S</code> - the sketch type</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SketchFillRequest<T,<wbr>S extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></span></div> +<div class="block">This is a callback request to the data source to fill a quantiles sketch, + which is returned to the caller.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SketchFillRequest.html" title="type parameter in SketchFillRequest">S</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRange(T,T,org.apache.datasketches.partitions.BoundsRule)" class="member-name-link">getRange</a><wbr>(<a href="SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a> lowerQuantile, + <a href="SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a> upperQuantile, + <a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a> boundsRule)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is a callback request to the data source to fill a quantiles sketch + with a range of data between upper and lower bounds.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getRange(T,T,org.apache.datasketches.partitions.BoundsRule)"> +<h3 id="getRange(java.lang.Object,java.lang.Object,org.apache.datasketches.partitions.BoundsRule)">getRange</h3> +<div class="member-signature"><span class="return-type"><a href="SketchFillRequest.html" title="type parameter in SketchFillRequest">S</a></span> <span class="element-name">getRange</span><wbr><span class="parameters">(<a href="SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a> lowerQuantile, + <a href="SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a> upperQuantile, + <a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a> boundsRule)</span></div> +<div class="block">This is a callback request to the data source to fill a quantiles sketch + with a range of data between upper and lower bounds. Which of these bounds are to be included is determined by + the <i>BoundsRule</i>. + + <p>This range of data may or may not be subsequently further partitioned.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lowerQuantile</code> - the lowest quantile of a range</dd> +<dd><code>upperQuantile</code> - the highest quantile of a range</dd> +<dd><code>boundsRule</code> - determines which quantile bounds to include</dd> +<dt>Returns:</dt> +<dd>a quantiles sketch filled from the given upper and lower bounds.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/class-use/BoundsRule.html b/docs/7.0.X/org/apache/datasketches/partitions/class-use/BoundsRule.html new file mode 100644 index 000000000..0a48a044f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/class-use/BoundsRule.html @@ -0,0 +1,120 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.partitions.BoundsRule (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.partitions, enum: BoundsRule"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.partitions.BoundsRule" class="title">Uses of Enum Class<br>org.apache.datasketches.partitions.BoundsRule</h1> +</div> +<div class="caption"><span>Packages that use <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last even-row-color"> </div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a> in <a href="../package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Fields in <a href="../package-summary.html">org.apache.datasketches.partitions</a> declared as <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Partitioner.PartitionBoundsRow.</span><code><a href="../Partitioner.PartitionBoundsRow.html#rule" class="member-name-link">rule</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The BoundsRule for this partition description row.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.partitions</a> that return <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsRule.</span><code><a href="../BoundsRule.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsRule.</span><code><a href="../BoundsRule.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.partitions</a> with parameters of type <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SketchFillRequest.html" title="type parameter in SketchFillRequest">S</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SketchFillRequest.</span><code><a href="../SketchFillRequest.html#getRange(T,T,org.apache.datasketches.partitions.BoundsRule)" class="member-name-link">getRange</a><wbr>(<a href="../SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a> lowerQuantile, + <a href="../SketchFillRequest.html" title="type parameter in SketchFillRequest">T</a> upperQuantile, + <a href="../BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a> boundsRule)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is a callback request to the data source to fill a quantiles sketch + with a range of data between upper and lower bounds.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.PartitionBoundsRow.html b/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.PartitionBoundsRow.html new file mode 100644 index 000000000..f7d68159c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.PartitionBoundsRow.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.partitions.Partitioner.PartitionBoundsRow (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.partitions, class: Partitioner, class: PartitionBoundsRow"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.partitions.Partitioner.PartitionBoundsRow" class="title">Uses of Class<br>org.apache.datasketches.partitions.Partitioner.PartitionBoundsRow</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last even-row-color"> </div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a> in <a href="../package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.partitions</a> that return types with arguments of type <a href="../Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><<a href="../Partitioner.html" title="type parameter in Partitioner">T</a>>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Partitioner.</span><code><a href="../Partitioner.html#partition(S)" class="member-name-link">partition</a><wbr>(<a href="../Partitioner.html" title="type parameter in Partitioner">S</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">This initiates the partitioning process</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.StackElement.html b/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.StackElement.html new file mode 100644 index 000000000..5a894e26b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.StackElement.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.partitions.Partitioner.StackElement (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.partitions, class: Partitioner, class: StackElement"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.partitions.Partitioner.StackElement" class="title">Uses of Class<br>org.apache.datasketches.partitions.Partitioner.StackElement</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last even-row-color"> </div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a> in <a href="../package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.partitions</a> with parameters of type <a href="../Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../Partitioner.PartitionBoundsRow.html#%3Cinit%3E(org.apache.datasketches.partitions.Partitioner.StackElement)" class="member-name-link">PartitionBoundsRow</a><wbr>(<a href="../Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><<a href="../Partitioner.PartitionBoundsRow.html" title="type parameter in Partitioner.PartitionBoundsRow">T</a>> se)</code></div> +<div class="col-last even-row-color"> +<div class="block">The constructor for the StackElement class.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.html b/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.html new file mode 100644 index 000000000..d1e40c215 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/class-use/Partitioner.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.partitions.Partitioner (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.partitions, class: Partitioner"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Partitioner.html" title="class in org.apache.datasketches.partitions">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.partitions.Partitioner" class="title">Uses of Class<br>org.apache.datasketches.partitions.Partitioner</h1> +</div> +No usage of org.apache.datasketches.partitions.Partitioner</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/class-use/SketchFillRequest.html b/docs/7.0.X/org/apache/datasketches/partitions/class-use/SketchFillRequest.html new file mode 100644 index 000000000..250fc424f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/class-use/SketchFillRequest.html @@ -0,0 +1,99 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.partitions.SketchFillRequest (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.partitions, interface: SketchFillRequest"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.partitions.SketchFillRequest" class="title">Uses of Interface<br>org.apache.datasketches.partitions.SketchFillRequest</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last even-row-color"> </div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a> in <a href="../package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.partitions</a> with parameters of type <a href="../SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../Partitioner.html#%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest)" class="member-name-link">Partitioner</a><wbr>(long tgtPartitionSize, + int maxPartsPerPass, + <a href="../SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="../Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="../Partitioner.html" title="type parameter in Partitioner">S</a>> fillReq)</code></div> +<div class="col-last even-row-color"> +<div class="block">This constructor assumes a QuantileSearchCriteria of INCLUSIVE.</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../Partitioner.html#%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">Partitioner</a><wbr>(long tgtPartitionSize, + int maxPartsPerSk, + <a href="../SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="../Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="../Partitioner.html" title="type parameter in Partitioner">S</a>> fillReq, + <a href="../../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> criteria)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This constructor includes the QuantileSearchCriteria criteria as a parameter.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/package-summary.html b/docs/7.0.X/org/apache/datasketches/partitions/package-summary.html new file mode 100644 index 000000000..34c767cd8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/package-summary.html @@ -0,0 +1,127 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.partitions (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.partitions"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li>Description | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.partitions" class="title">Package org.apache.datasketches.partitions</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.partitions</span></div> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="BoundsRule.html" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">This instructs the user about which of the upper and lower bounds of a partition definition row + should be included with the returned data.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a><T,<wbr>S extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">A partitioning process that can partition very large data sets into thousands + of partitions of approximately the same size.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Defines a row for List of PartitionBounds.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Holds data for a Stack element</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><T,<wbr>S extends <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">This is a callback request to the data source to fill a quantiles sketch, + which is returned to the caller.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/package-tree.html b/docs/7.0.X/org/apache/datasketches/partitions/package-tree.html new file mode 100644 index 000000000..aab1deb2e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/package-tree.html @@ -0,0 +1,98 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.partitions Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.partitions"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.partitions</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.partitions.<a href="Partitioner.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner</a><T,<wbr>S></li> +<li class="circle">org.apache.datasketches.partitions.<a href="Partitioner.PartitionBoundsRow.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><T></li> +<li class="circle">org.apache.datasketches.partitions.<a href="Partitioner.StackElement.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><T></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.partitions.<a href="SketchFillRequest.html" class="type-name-link" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><T,<wbr>S></li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.partitions.<a href="BoundsRule.html" class="type-name-link" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/partitions/package-use.html b/docs/7.0.X/org/apache/datasketches/partitions/package-use.html new file mode 100644 index 000000000..298b8b56d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/partitions/package-use.html @@ -0,0 +1,100 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.partitions (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.partitions"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.partitions" class="title">Uses of Package<br>org.apache.datasketches.partitions</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.partitions</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last even-row-color"> </div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.partitions</a> used by <a href="package-summary.html">org.apache.datasketches.partitions</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/BoundsRule.html#org.apache.datasketches.partitions">BoundsRule</a></div> +<div class="col-last even-row-color"> +<div class="block">This instructs the user about which of the upper and lower bounds of a partition definition row + should be included with the returned data.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Partitioner.PartitionBoundsRow.html#org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></div> +<div class="col-last odd-row-color"> +<div class="block">Defines a row for List of PartitionBounds.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/Partitioner.StackElement.html#org.apache.datasketches.partitions">Partitioner.StackElement</a></div> +<div class="col-last even-row-color"> +<div class="block">Holds data for a Stack element</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SketchFillRequest.html#org.apache.datasketches.partitions">SketchFillRequest</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is a callback request to the data source to fill a quantiles sketch, + which is returned to the caller.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/ClassicUtil.html b/docs/7.0.X/org/apache/datasketches/quantiles/ClassicUtil.html new file mode 100644 index 000000000..1f42cddf7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/ClassicUtil.html @@ -0,0 +1,182 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ClassicUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: ClassicUtil"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ClassicUtil.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class ClassicUtil" class="title">Class ClassicUtil</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.ClassicUtil</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ClassicUtil</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Utilities for the classic quantiles sketches and independent of the type.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon</a><wbr>(double epsilon, + boolean pmf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Used by Classic Quantiles.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(int k, + boolean pmf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Used by Classic Quantiles.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getNormalizedRankError(int,boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(int k, + boolean pmf)</span></div> +<div class="block">Used by Classic Quantiles. + Gets the normalized rank error given k and pmf for the Quantiles DoubleSketch and ItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - the configuration parameter</dd> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, the normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getKFromEpsilon(double,boolean)"> +<h3>getKFromEpsilon</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getKFromEpsilon</span><wbr><span class="parameters">(double epsilon, + boolean pmf)</span></div> +<div class="block">Used by Classic Quantiles. + Gets the approximate <em>k</em> to use given epsilon, the normalized rank error + for the Quantiles DoubleSketch and ItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>epsilon</code> - the normalized rank error between zero and one.</dd> +<dd><code>pmf</code> - if true, this function returns <em>k</em> assuming the input epsilon + is the desired "double-sided" epsilon for the getPMF() function. Otherwise, this function + returns <em>k</em> assuming the input epsilon is the desired "single-sided" + epsilon for all the other queries.</dd> +<dt>Returns:</dt> +<dd><i>k</i> given epsilon.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/CompactDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/CompactDoublesSketch.html new file mode 100644 index 000000000..5b2f8cf99 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/CompactDoublesSketch.html @@ -0,0 +1,215 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CompactDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: CompactDoublesSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CompactDoublesSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class CompactDoublesSketch" class="title">Class CompactDoublesSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">org.apache.datasketches.quantiles.DoublesSketch</a> +<div class="inheritance">org.apache.datasketches.quantiles.CompactDoublesSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">CompactDoublesSketch</span> +<span class="extends-implements">extends <a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span></div> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is read only.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double quantile)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantiles.DoublesSketch">Methods inherited from class org.apache.datasketches.quantiles.<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></h3> +<code><a href="DoublesSketch.html#builder()">builder</a>, <a href="DoublesSketch.html#downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)">downSample</a>, <a href="DoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a>, <a href="DoublesSketch.html#getCompactSerialiedSizeBytes(int,long)">getCompactSerialiedSizeBytes</a>, <a href="DoublesSketch.html#getCurrentCompactSerializedSizeBytes()">getCurrentCompactSerializedSizeBytes</a>, <a href="DoublesSketch.html#getCurrentUpdatableSerializedSizeBytes()">getCurrentUpdatableSerializedSizeBytes</a>, <a href="DoublesSketch.html#getK()">getK</a>, <a href="DoublesSketch.html#getKFromEpsilon(double,boolean)">getKFromEpsilon</a>, <a href="DoublesSketch.html#getMaxItem()">getMaxItem</a>, <a href="DoublesSketch.html#getMinItem()">getMinItem</a>, <a href="DoublesSketch.html#getN()">getN</a>, <a href="DoublesSketch.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="DoublesSketch.html#getNormalizedRankError(int,boolean)">getNormalizedRankError</a>, <a href="DoublesSketch.html#getNumRetained()">getNumRetained</a>, <a href="DoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a>, <a href="DoublesSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a>, <a href="DoublesSketch.html#getQuantileLowerBound(double)">getQuantileLowerBound</a>, <a href="DoublesSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a>, <a href="DoublesSketch.html#getQuantileUpperBound(double)">getQuantileUpperBound</a>, <a href="DoublesSketch.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a>, <a href="DoublesSketch.html#getRankLowerBound(double)">getRankLowerBound</a>, <a href="DoublesSketch.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a>, <a href="DoublesSketch.html#getRankUpperBound(double)">getRankUpperBound</a>, <a href="DoublesSketch.html#getSerializedSizeBytes()">getSerializedSizeBytes</a>, <a href="DoublesSketch.html#getSortedView()">getSortedView</a>, <a href="DoublesSketch.html#getUpdatableStorageBytes(int,long)">getUpdatableStorageBytes</a>, <a href="DoublesSketch.html#hasMemory()">hasMemory</a>, <a href="DoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)">heapify</a>, <a href="DoublesSketch.html#isDirect()">isDirect</a>, <a href="DoublesSketch.html#isEmpty()">isEmpty</a>, <a href="DoublesSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="DoublesSketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="DoublesSketch.html#iterator()">iterator</a>, <a href="DoublesSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory)">putMemory</a>, <a href="DoublesSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory,boolean)">putMemory</a>, <a href="DoublesSketch.html#toByteArray()">toByteArray</a>, <a href="DoublesSketch.html#toByteArray(boolean)">toByteArray</a>, <a href="DoublesSketch.html#toString()">toString</a>, <a href="DoublesSketch.html#toString(boolean,boolean)">toString</a>, <a href="DoublesSketch.html#toString(byte%5B%5D)">toString</a>, <a href="DoublesSketch.html#toString(org.apache.datasketches.memory.Memory)">toString</a>, <a href="DoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesDoublesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double)">getRank</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D)">getRanks</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is read only.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSketch.html#isReadOnly()">isReadOnly</a></code> in class <code><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is read only.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="DoublesSketch.html#reset()">DoublesSketch</a></code></span></div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p> + + <p>The parameter <i>k</i> will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSketch.html#reset()">reset</a></code> in class <code><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double quantile)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#update(double)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - from a stream of items. NaNs are ignored.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketch.html new file mode 100644 index 000000000..24dca3a25 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketch.html @@ -0,0 +1,1244 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: DoublesSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class DoublesSketch" class="title">Class DoublesSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.DoublesSketch</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code>, <code><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">DoublesSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></div> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi: + + <p>Reference: <a href="http://dblp.org/rec/html/journals/tods/AgarwalCHPWY13"></a></p> + + <p>A <i>k</i> of 128 produces a normalized, rank error of about 1.7%. + For example, the median returned from getQuantile(0.5) will be between the actual quantiles + from the hypothetically sorted array of input quantiles at normalized ranks of 0.483 and 0.517, with + a confidence of about 99%.</p> + + <pre> +Table Guide for DoublesSketch Size in Bytes and Approximate Error: + K => | 16 32 64 128 256 512 1,024 + ~ Error => | 12.145% 6.359% 3.317% 1.725% 0.894% 0.463% 0.239% + N | Size in Bytes -> +------------------------------------------------------------------------ + 0 | 8 8 8 8 8 8 8 + 1 | 72 72 72 72 72 72 72 + 3 | 72 72 72 72 72 72 72 + 7 | 104 104 104 104 104 104 104 + 15 | 168 168 168 168 168 168 168 + 31 | 296 296 296 296 296 296 296 + 63 | 424 552 552 552 552 552 552 + 127 | 552 808 1,064 1,064 1,064 1,064 1,064 + 255 | 680 1,064 1,576 2,088 2,088 2,088 2,088 + 511 | 808 1,320 2,088 3,112 4,136 4,136 4,136 + 1,023 | 936 1,576 2,600 4,136 6,184 8,232 8,232 + 2,047 | 1,064 1,832 3,112 5,160 8,232 12,328 16,424 + 4,095 | 1,192 2,088 3,624 6,184 10,280 16,424 24,616 + 8,191 | 1,320 2,344 4,136 7,208 12,328 20,520 32,808 + 16,383 | 1,448 2,600 4,648 8,232 14,376 24,616 41,000 + 32,767 | 1,576 2,856 5,160 9,256 16,424 28,712 49,192 + 65,535 | 1,704 3,112 5,672 10,280 18,472 32,808 57,384 + 131,071 | 1,832 3,368 6,184 11,304 20,520 36,904 65,576 + 262,143 | 1,960 3,624 6,696 12,328 22,568 41,000 73,768 + 524,287 | 2,088 3,880 7,208 13,352 24,616 45,096 81,960 + 1,048,575 | 2,216 4,136 7,720 14,376 26,664 49,192 90,152 + 2,097,151 | 2,344 4,392 8,232 15,400 28,712 53,288 98,344 + 4,194,303 | 2,472 4,648 8,744 16,424 30,760 57,384 106,536 + 8,388,607 | 2,600 4,904 9,256 17,448 32,808 61,480 114,728 + 16,777,215 | 2,728 5,160 9,768 18,472 34,856 65,576 122,920 + 33,554,431 | 2,856 5,416 10,280 19,496 36,904 69,672 131,112 + 67,108,863 | 2,984 5,672 10,792 20,520 38,952 73,768 139,304 + 134,217,727 | 3,112 5,928 11,304 21,544 41,000 77,864 147,496 + 268,435,455 | 3,240 6,184 11,816 22,568 43,048 81,960 155,688 + 536,870,911 | 3,368 6,440 12,328 23,592 45,096 86,056 163,880 + 1,073,741,823 | 3,496 6,696 12,840 24,616 47,144 90,152 172,072 + 2,147,483,647 | 3,624 6,952 13,352 25,640 49,192 94,248 180,264 + 4,294,967,295 | 3,752 7,208 13,864 26,664 51,240 98,344 188,456 + </pre></div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a new builder</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">downSample</a><wbr>(<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> srcSketch, + int smallerK, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">From an source sketch, create a new sketch that must have a smaller K.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCompactSerialiedSizeBytes(int,long)" class="member-name-link">getCompactSerialiedSizeBytes</a><wbr>(int k, + long n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the number of bytes a DoublesSketch would require to store in compact form + given <i>k</i> and <i>n</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentCompactSerializedSizeBytes()" class="member-name-link">getCurrentCompactSerializedSizeBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of bytes this sketch would require to store in the compact Memory Format.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentUpdatableSerializedSizeBytes()" class="member-name-link">getCurrentUpdatableSerializedSizeBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of bytes this sketch would require to store in the updatable Memory Format.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon</a><wbr>(double epsilon, + boolean pmf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(boolean pmf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(int k, + boolean pmf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the normalized rank error given k and pmf.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(double[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpdatableStorageBytes(int,long)" class="member-name-link">getUpdatableStorageBytes</a><wbr>(int k, + long n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the number of bytes a sketch would require to store in updatable form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is empty.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is in estimation mode.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch is read only.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource</a><wbr>(org.apache.datasketches.memory.Memory that)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#putMemory(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">putMemory</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Puts the current sketch into the given Memory in compact form if there is sufficient space, + otherwise, it throws an error.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#putMemory(org.apache.datasketches.memory.WritableMemory,boolean)" class="member-name-link">putMemory</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + boolean compact)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Puts the current sketch into the given Memory if there is sufficient space, otherwise, + throws an error.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(boolean)" class="member-name-link">toByteArray</a><wbr>(boolean compact)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize this sketch in a byte array form.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean withLevels, + boolean withLevelsAndItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a DoublesSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a DoublesSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap this sketch around the given Memory image of a DoublesSketch, compact or updatable.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesDoublesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double)">getRank</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D)">getRanks</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#update(double)">update</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="builder()"> +<h3>builder</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></span> <span class="element-name">builder</span>()</div> +<div class="block">Returns a new builder</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a new builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch. + The resulting sketch will not retain any link to the source Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a Memory image of a Sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a heap-based Sketch based on the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap this sketch around the given Memory image of a DoublesSketch, compact or updatable. + A DirectUpdateDoublesSketch can only wrap an updatable array, and a + DirectCompactDoublesSketch can only wrap a compact array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given Memory image of a DoublesSketch that may have data,</dd> +<dt>Returns:</dt> +<dd>a sketch that wraps the given srcMem</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">double</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getMaxItem()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns the maximum item of the stream. This is provided for convenience and may be different from the + item returned by <i>getQuantile(1.0)</i>.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">double</span> <span class="element-name">getMinItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getMinItem()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns the minimum item of the stream. This is provided for convenience and may be different from the + item returned by <i>getQuantile(0.0)</i>.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getMinItem()">getMinItem</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(double quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.99.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(double[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getK()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getN()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the length of the input stream offered to the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(boolean pmf)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">QuantilesAPI</a></code></span></div> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one. + The epsilon returned is a best fit to 99 percent confidence empirically measured max error + in thousands of trials.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(int,boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(int k, + boolean pmf)</span></div> +<div class="block">Gets the normalized rank error given k and pmf. + Static method version of the <i>getNormalizedRankError(boolean)</i>. + The epsilon returned is a best fit to 99 percent confidence empirically measured max error + in thousands of trials.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - the configuration parameter</dd> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, the normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getKFromEpsilon(double,boolean)"> +<h3>getKFromEpsilon</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getKFromEpsilon</span><wbr><span class="parameters">(double epsilon, + boolean pmf)</span></div> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>epsilon</code> - the normalized rank error between zero and one.</dd> +<dd><code>pmf</code> - if true, this function returns <em>k</em> assuming the input epsilon + is the desired "double-sided" epsilon for the getPMF() function. Otherwise, this function + returns <em>k</em> assuming the input epsilon is the desired "single-sided" + epsilon for all the other queries.</dd> +<dt>Returns:</dt> +<dd><i>k</i> given epsilon.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is in estimation mode.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is read only.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is read only.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isSameResource(org.apache.datasketches.memory.Memory)"> +<h3>isSameResource</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSameResource</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory that)</span></div> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>. The capacities must be the same. If <i>this</i> is a region, + the region offset must also be the same.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>that</code> - A different non-null object</dd> +<dt>Returns:</dt> +<dd>true if the backing resource of <i>this</i> is the same as the backing resource + of <i>that</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#toByteArray()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(boolean)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(boolean compact)</span></div> +<div class="block">Serialize this sketch in a byte array form.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>compact</code> - if true the sketch will be serialized in compact form. + DirectCompactDoublesSketch can wrap() only a compact byte array; + DirectUpdateDoublesSketch can wrap() only a updatable byte array.</dd> +<dt>Returns:</dt> +<dd>this sketch in a byte array form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>a summary of the key parameters of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean withLevels, + boolean withLevelsAndItems)</span></div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>withLevels</code> - if true includes sketch levels array summary information</dd> +<dd><code>withLevelsAndItems</code> - if true include detail of levels array and items array together</dd> +<dt>Returns:</dt> +<dd>human readable summary information about this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a DoublesSketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a DoublesSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a DoublesSketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a DoublesSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)"> +<h3>downSample</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span> <span class="element-name">downSample</span><wbr><span class="parameters">(<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> srcSketch, + int smallerK, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">From an source sketch, create a new sketch that must have a smaller K. + The original sketch is not modified.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcSketch</code> - the sourcing sketch</dd> +<dd><code>smallerK</code> - the new sketch's K that must be smaller than this K. + It is required that this.getK() = smallerK * 2^(nonnegative integer).</dd> +<dd><code>dstMem</code> - the destination Memory. It must not overlap the Memory of this sketch. + If null, a heap sketch will be returned, otherwise it will be off-heap.</dd> +<dt>Returns:</dt> +<dd>the new sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentCompactSerializedSizeBytes()"> +<h3>getCurrentCompactSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentCompactSerializedSizeBytes</span>()</div> +<div class="block">Returns the current number of bytes this sketch would require to store in the compact Memory Format.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current number of bytes this sketch would require to store in the compact Memory Format.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactSerialiedSizeBytes(int,long)"> +<h3>getCompactSerialiedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getCompactSerialiedSizeBytes</span><wbr><span class="parameters">(int k, + long n)</span></div> +<div class="block">Returns the number of bytes a DoublesSketch would require to store in compact form + given <i>k</i> and <i>n</i>. The compact form is not updatable.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - the size configuration parameter for the sketch</dd> +<dd><code>n</code> - the number of quantiles input into the sketch</dd> +<dt>Returns:</dt> +<dd>the number of bytes required to store this sketch in compact form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes()"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getSerializedSizeBytes()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getSerializedSizeBytes()">getSerializedSizeBytes</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the number of bytes this sketch would require if serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentUpdatableSerializedSizeBytes()"> +<h3>getCurrentUpdatableSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentUpdatableSerializedSizeBytes</span>()</div> +<div class="block">Returns the current number of bytes this sketch would require to store in the updatable Memory Format.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current number of bytes this sketch would require to store in the updatable Memory Format.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpdatableStorageBytes(int,long)"> +<h3>getUpdatableStorageBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getUpdatableStorageBytes</span><wbr><span class="parameters">(int k, + long n)</span></div> +<div class="block">Returns the number of bytes a sketch would require to store in updatable form. + This uses roughly 2X the storage of the compact form + given <i>k</i> and <i>n</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - the size configuration parameter for the sketch</dd> +<dd><code>n</code> - the number of quantiles input into the sketch</dd> +<dt>Returns:</dt> +<dd>the number of bytes this sketch would require to store in updatable form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putMemory(org.apache.datasketches.memory.WritableMemory)"> +<h3>putMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Puts the current sketch into the given Memory in compact form if there is sufficient space, + otherwise, it throws an error.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the given memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putMemory(org.apache.datasketches.memory.WritableMemory,boolean)"> +<h3>putMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem, + boolean compact)</span></div> +<div class="block">Puts the current sketch into the given Memory if there is sufficient space, otherwise, + throws an error.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the given memory.</dd> +<dd><code>compact</code> - if true, compacts and sorts the base buffer, which optimizes merge + performance at the cost of slightly increased serialization time.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#iterator()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p> + + <p>The parameter <i>k</i> will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../quantilescommon/DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesAPI.html#getSortedView()">QuantilesDoublesAPI</a></code></span></div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketchBuilder.html new file mode 100644 index 000000000..207aa1950 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketchBuilder.html @@ -0,0 +1,255 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: DoublesSketchBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesSketchBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class DoublesSketchBuilder" class="title">Class DoublesSketchBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.DoublesSketchBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DoublesSketchBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">For building a new quantiles DoublesSketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">DoublesSketchBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor for a new DoublesSketchBuilder.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an UpdateDoublesSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a quantiles UpdateDoublesSketch with the current configuration of this builder + and the specified backing destination Memory store.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the current configured <i>k</i></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setK(int)" class="member-name-link">setK</a><wbr>(int k)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the parameter <i>k</i> that determines the accuracy and size of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates a human readable string that describes the current configuration of this builder.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>DoublesSketchBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoublesSketchBuilder</span>()</div> +<div class="block">Constructor for a new DoublesSketchBuilder. The default configuration is + <ul> + <li>k: 128. This produces a normalized rank error of about 1.7%</li> + <li>Memory: null</li> + </ul></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setK(int)"> +<h3>setK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></span> <span class="element-name">setK</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Sets the parameter <i>k</i> that determines the accuracy and size of the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - determines the accuracy and size of the sketch. + It is recommended that <i>k</i> be a power of 2 to enable unioning of sketches with + different <i>k</i>. It is only possible to union from + larger <i>k</i> to smaller <i>k</i>.</dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block">Gets the current configured <i>k</i></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current configured <i>k</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build()"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span> <span class="element-name">build</span>()</div> +<div class="block">Returns an UpdateDoublesSketch with the current configuration of this Builder.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a UpdateDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build(org.apache.datasketches.memory.WritableMemory)"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span> <span class="element-name">build</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns a quantiles UpdateDoublesSketch with the current configuration of this builder + and the specified backing destination Memory store.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - destination memory for use by the sketch</dd> +<dt>Returns:</dt> +<dd>an UpdateDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Creates a human readable string that describes the current configuration of this builder.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketchIterator.html new file mode 100644 index 000000000..e2031aaf1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesSketchIterator.html @@ -0,0 +1,197 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: DoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class DoublesSketchIterator" class="title">Class DoublesSketchIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.DoublesSketchIterator</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code>, <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DoublesSketchIterator</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="block">Iterator over DoublesSketch. The order is not defined.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the double quantile at the current index.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWeight()" class="member-name-link">getWeight</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the natural weight at the current index.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Advances the index and checks if it is valid.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html#getQuantile()">QuantilesDoublesSketchIterator</a></code></span></div> +<div class="block">Gets the double quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html#getQuantile()">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the double quantile at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getWeight()"> +<h3>getWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getWeight</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Gets the natural weight at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the natural weight at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Advances the index and checks if it is valid. + The state of this iterator is undefined before the first call of this method.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>true if the next index is valid.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/DoublesUnion.html b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesUnion.html new file mode 100644 index 000000000..8617f7fef --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesUnion.html @@ -0,0 +1,547 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: DoublesUnion"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesUnion.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class DoublesUnion" class="title">Class DoublesUnion</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.DoublesUnion</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">DoublesUnion</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The API for Union operations for quantiles DoublesSketches</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">DoublesUnion</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a new UnionBuilder</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEffectiveK()" class="member-name-link">getEffectiveK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the effective <i>k</i> of this Union.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxK()" class="member-name-link">getMaxK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the configured <i>maxK</i> of this Union.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Places the result of this Union into the provided memory as an UpdateDoublesSketch, + which enables further update operations on the resulting sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResultAndReset()" class="member-name-link">getResultAndReset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this union's data structure is backed by Memory or WritableMemory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given memory + image of a sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.quantiles.DoublesSketch)" class="member-name-link">heapify</a><wbr>(<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> sketch)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this union is off-heap (direct)</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this union is empty</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSameResource(org.apache.datasketches.memory.Memory)" class="member-name-link">isSameResource</a><wbr>(org.apache.datasketches.memory.Memory that)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Resets this Union to a virgin state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Serialize this union to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns summary information about the backing sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean sketchSummary, + boolean dataDetail)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns summary information about the backing sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#union(org.apache.datasketches.memory.Memory)" class="member-name-link">union</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#union(org.apache.datasketches.quantiles.DoublesSketch)" class="member-name-link">union</a><wbr>(<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> sketchIn)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double dataItem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update this union with the given double (or float) data Item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a read-only Union object that wraps off-heap data of the given memory image of + a sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an updatable Union object that wraps off-heap data of the given memory image of + a sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>DoublesUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoublesUnion</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="builder()"> +<h3>builder</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></span> <span class="element-name">builder</span>()</div> +<div class="block">Returns a new UnionBuilder</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a new UnionBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.quantiles.DoublesSketch)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> sketch)</span></div> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - A DoublesSketch to be used as a source of data only and will not be modified.</dd> +<dt>Returns:</dt> +<dd>a DoublesUnion object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given memory + image of a sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - A memory image of a DoublesSketch to be used as a source of data, + but will not be modified.</dd> +<dt>Returns:</dt> +<dd>a Union object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a read-only Union object that wraps off-heap data of the given memory image of + a sketch. The data structures of the Union remain off-heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - A memory region to be used as the data structure for the sketch + and will be modified.</dd> +<dt>Returns:</dt> +<dd>a Union object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory mem)</span></div> +<div class="block">Returns an updatable Union object that wraps off-heap data of the given memory image of + a sketch. The data structures of the Union remain off-heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - A memory region to be used as the data structure for the sketch + and will be modified.</dd> +<dt>Returns:</dt> +<dd>a Union object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block">Returns true if this union's data structure is backed by Memory or WritableMemory.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this union's data structure is backed by Memory or WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block">Returns true if this union is off-heap (direct)</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this union is off-heap (direct)</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if this union is empty</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this union is empty</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxK()"> +<h3>getMaxK</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getMaxK</span>()</div> +<div class="block">Returns the configured <i>maxK</i> of this Union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the configured <i>maxK</i> of this Union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEffectiveK()"> +<h3>getEffectiveK</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getEffectiveK</span>()</div> +<div class="block">Returns the effective <i>k</i> of this Union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the effective <i>k</i> of this Union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.quantiles.DoublesSketch)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> sketchIn)</span></div> +<div class="block">Iterative union operation, which means this method can be repeatedly called. + Merges the given sketch into this union object. + The given sketch is not modified. + It is required that the ratio of the two K's be a power of 2. + This is easily satisfied if each of the K's are already a power of 2. + If the given sketch is null or empty it is ignored. + + <p>It is required that the results of the union operation, which can be obtained at any time, + is obtained from <a href="#getResult()"><code>getResult()</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - the sketch to be merged into this one.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.memory.Memory)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Iterative union operation, which means this method can be repeatedly called. + Merges the given Memory image of a DoublesSketch into this union object. + The given Memory object is not modified and a link to it is not retained. + It is required that the ratio of the two K's be a power of 2. + This is easily satisfied if each of the K's are already a power of 2. + If the given sketch is null or empty it is ignored. + + <p>It is required that the results of the union operation, which can be obtained at any time, + is obtained from <a href="#getResult()"><code>getResult()</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory image of sketch to be merged</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double dataItem)</span></div> +<div class="block">Update this union with the given double (or float) data Item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dataItem</code> - The given double datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch. The Union state has not been changed, which allows + further union operations.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of this Union operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(org.apache.datasketches.memory.WritableMemory)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Places the result of this Union into the provided memory as an UpdateDoublesSketch, + which enables further update operations on the resulting sketch. The Union state has not + been changed, which allows further union operations.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the destination memory for the result</dd> +<dt>Returns:</dt> +<dd>the result of this Union operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResultAndReset()"> +<h3>getResultAndReset</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span> <span class="element-name">getResultAndReset</span>()</div> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch. The Union is reset to the virgin state.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of this Union operation and reset.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this Union to a virgin state.</div> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Serialize this union to a byte array. Result is an UpdateDoublesSketch, serialized in an + unordered, non-compact form. The resulting byte[] can be heapified or wrapped as either a + sketch or a union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>byte array of this union</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns summary information about the backing sketch.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean sketchSummary, + boolean dataDetail)</span></div> +<div class="block">Returns summary information about the backing sketch. Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchSummary</code> - if true includes sketch summary</dd> +<dd><code>dataDetail</code> - if true includes data detail</dd> +<dt>Returns:</dt> +<dd>summary information about the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isSameResource(org.apache.datasketches.memory.Memory)"> +<h3>isSameResource</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isSameResource</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory that)</span></div> +<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource + of <i>that</i>. The capacities must be the same. If <i>this</i> is a region, + the region offset must also be the same.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>that</code> - A different non-null object</dd> +<dt>Returns:</dt> +<dd>true if the backing resource of <i>this</i> is the same as the backing resource + of <i>that</i>.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/DoublesUnionBuilder.html b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesUnionBuilder.html new file mode 100644 index 000000000..71ede8e8d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/DoublesUnionBuilder.html @@ -0,0 +1,241 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesUnionBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: DoublesUnionBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesUnionBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class DoublesUnionBuilder" class="title">Class DoublesUnionBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.DoublesUnionBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DoublesUnionBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">For building a new DoublesSketch Union operation.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">DoublesUnionBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor for a new DoublesUnionBuilder.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a new empty Union object with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a new empty Union object with the current configuration of this Builder + and the specified backing destination Memory store.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxK()" class="member-name-link">getMaxK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the current configured <i>maxK</i></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxK(int)" class="member-name-link">setMaxK</a><wbr>(int maxK)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the parameter <i>masK</i> that determines the maximum size of the sketch that + results from a union and its accuracy.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>DoublesUnionBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoublesUnionBuilder</span>()</div> +<div class="block">Constructor for a new DoublesUnionBuilder. The default configuration is + <ul> + <li>k: 128. This produces a normalized rank error of about 1.7%</li> + <li>Memory: null</li> + </ul></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setMaxK(int)"> +<h3>setMaxK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></span> <span class="element-name">setMaxK</span><wbr><span class="parameters">(int maxK)</span></div> +<div class="block">Sets the parameter <i>masK</i> that determines the maximum size of the sketch that + results from a union and its accuracy.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxK</code> - determines the accuracy and size of the union and is a maximum. + The effective <i>k</i> can be smaller due to unions with smaller <i>k</i> sketches. + It is recommended that <i>maxK</i> be a power of 2 to enable unioning of sketches with + different <i>k</i>.</dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxK()"> +<h3>getMaxK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxK</span>()</div> +<div class="block">Gets the current configured <i>maxK</i></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current configured <i>maxK</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build()"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span> <span class="element-name">build</span>()</div> +<div class="block">Returns a new empty Union object with the current configuration of this Builder.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a Union object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build(org.apache.datasketches.memory.WritableMemory)"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span> <span class="element-name">build</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns a new empty Union object with the current configuration of this Builder + and the specified backing destination Memory store.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the destination memory</dd> +<dt>Returns:</dt> +<dd>a Union object</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/ItemsSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/ItemsSketch.html new file mode 100644 index 000000000..57f70aade --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/ItemsSketch.html @@ -0,0 +1,1248 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: ItemsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ItemsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class ItemsSketch" class="title">Class ItemsSketch<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.ItemsSketch<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +</dl> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T></code>, <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code>, <code><a href="../quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ItemsSketch<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></span></div> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi: + + <p>Reference: <a href="http://dblp.org/rec/html/journals/tods/AgarwalCHPWY13"></a></p> + + <p>A <i>k</i> of 128 produces a normalized, rank error of about 1.7%. + For example, the median returned from getQuantile(0.5) will be between the actual quantiles + from the hypothetically sorted array of input quantiles at normalized ranks of 0.483 and 0.517, with + a confidence of about 99%.</p> + + <p>The size of an ItemsSketch is very dependent on the size of the generic Items input into the sketch, + so there is no comparable size table as there is for the DoublesSketch.</p></div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></code></div> +<div class="col-second even-row-color"><code><a href="#rand" class="member-name-link">rand</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Setting the seed makes the results of the sketch deterministic if the input items are + received in exactly the same order.</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#downSample(int)" class="member-name-link">downSample</a><wbr>(int newK)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">From an existing sketch, this creates a new sketch that can have a smaller K.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComparator()" class="member-name-link">getComparator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Comparator of T</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.Class,int,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Obtains a new instance of an ItemsSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.Class,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Obtains a new instance of an ItemsSketch using the DEFAULT_K.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapifies the given srcMem, which must be a Memory image of a ItemsSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getKFromEpsilon(double,boolean)" class="member-name-link">getKFromEpsilon</a><wbr>(double epsilon, + boolean pmf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(boolean pmf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNormalizedRankError(int,boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(int k, + boolean pmf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the normalized rank error given k and pmf.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is empty.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is in estimation mode.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is read only.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#putMemory(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">putMemory</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Puts the current sketch into the given Memory if there is sufficient space.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(boolean,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(boolean ordered, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize this sketch to a byte array form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize this sketch to a byte array form.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean withLevels, + boolean withLevelsAndItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns human readable summary information about this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of an ItemsSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of an ItemsSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.PartitioningFeature">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></h3> +<code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)">getPartitionBoundariesFromNumParts</a>, <a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)">getPartitionBoundariesFromPartSize</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesGenericAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></h3> +<code><a href="../quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getMaxPartitions()">getMaxPartitions</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getRank(T)">getRank</a>, <a href="../quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D)">getRanks</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SketchPartitionLimits">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></h3> +<code><a href="../quantilescommon/SketchPartitionLimits.html#getMinPartitionSizeItems()">getMinPartitionSizeItems</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="rand"> +<h3>rand</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></span> <span class="element-name">rand</span></div> +<div class="block">Setting the seed makes the results of the sketch deterministic if the input items are + received in exactly the same order. This is only useful when performing test comparisons, + otherwise, it is not recommended.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getInstance(java.lang.Class,java.util.Comparator)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</span></div> +<div class="block">Obtains a new instance of an ItemsSketch using the DEFAULT_K.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>clazz</code> - the given class of T</dd> +<dd><code>comparator</code> - to compare items</dd> +<dt>Returns:</dt> +<dd>an ItemSketch<T>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getInstance(java.lang.Class,int,java.util.Comparator)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</span></div> +<div class="block">Obtains a new instance of an ItemsSketch.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>clazz</code> - the given class of T</dd> +<dd><code>k</code> - Parameter that controls space usage of sketch and accuracy of estimates. + Must be greater than 2 and less than 65536 and a power of 2.</dd> +<dd><code>comparator</code> - to compare items</dd> +<dt>Returns:</dt> +<dd>an ItemSketch<T>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Heapifies the given srcMem, which must be a Memory image of a ItemsSketch</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>clazz</code> - the given class of T</dd> +<dd><code>srcMem</code> - a Memory image of a sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>comparator</code> - to compare items</dd> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a ItemSketch<T> on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getCDF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">getClassOfT</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getClassOfT()">getClassOfT</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the sketch item class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getComparator()"> +<h3>getComparator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">getComparator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getComparator()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns the Comparator of T</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getComparator()">getComparator</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>Comparator of the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></span> <span class="element-name">getMaxItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getMaxItem()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></span> <span class="element-name">getMinItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getMinItem()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getMinItem()">getMinItem</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromNumParts</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">getPartitionBoundariesFromNumParts</span><wbr><span class="parameters">(int numEquallySizedParts, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">PartitioningFeature</a></code></span></div> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromNumParts</a></code> in interface <code><a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>numEquallySizedParts</code> - an integer that specifies the number of equally sized partitions between + <a href="../quantilescommon/GenericPartitionBoundaries.html#getMinItem()"><code>getMinItem()</code></a> and + <a href="../quantilescommon/GenericPartitionBoundaries.html#getMaxItem()"><code>getMaxItem()</code></a>. + This must be a positive integer less than + <a href="../quantilescommon/SketchPartitionLimits.html#getMaxPartitions()"><code>getMaxPartitions()</code></a> + <ul> + <li>A 1 will return: minItem, maxItem.</li> + <li>A 2 will return: minItem, median quantile, maxItem.</li> + <li>Etc.</li> + </ul></dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromPartSize</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">getPartitionBoundariesFromPartSize</span><wbr><span class="parameters">(long nominalPartSizeItems, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">PartitioningFeature</a></code></span></div> +<div class="block">This method returns an instance of + <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromPartSize</a></code> in interface <code><a href="../quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>nominalPartSizeItems</code> - an integer that specifies the nominal size, in items, of each target partition. + This must be a positive integer greater than + <a href="../quantilescommon/SketchPartitionLimits.html#getMinPartitionSizeItems()"><code>getMinPartitionSizeItems()</code></a>.</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="../quantilescommon/GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getPMF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileLowerBound(double)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a></span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileUpperBound(double)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRank(java.lang.Object,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">QuantilesAPI</a></code></span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">QuantilesAPI</a></code></span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRanks(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#iterator()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getK()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getN()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/SketchPartitionLimits.html#getN()">getN</a></code> in interface <code><a href="../quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code></dd> +<dt>Returns:</dt> +<dd>the length of the input stream offered to the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(boolean pmf)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">QuantilesAPI</a></code></span></div> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one. + The epsilon returned is a best fit to 99 percent confidence empirically measured max error + in thousands of trials.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(int,boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(int k, + boolean pmf)</span></div> +<div class="block">Gets the normalized rank error given k and pmf. + Static method version of the <a href="#getNormalizedRankError(boolean)"><code>getNormalizedRankError(boolean)</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - the configuration parameter</dd> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, the normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getKFromEpsilon(double,boolean)"> +<h3>getKFromEpsilon</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getKFromEpsilon</span><wbr><span class="parameters">(double epsilon, + boolean pmf)</span></div> +<div class="block">Gets the approximate <em>k</em> to use given epsilon, the normalized rank error.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>epsilon</code> - the normalized rank error between zero and one.</dd> +<dd><code>pmf</code> - if true, this function returns <em>k</em> assuming the input epsilon + is the desired "double-sided" epsilon for the getPMF() function. Otherwise, this function + returns <em>k</em> assuming the input epsilon is the desired "single-sided" + epsilon for all the other queries.</dd> +<dt>Returns:</dt> +<dd><i>k</i> given epsilon.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is in estimation mode.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is read only.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is read only.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#reset()">QuantilesAPI</a></code></span></div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</span></div> +<div class="block">Serialize this sketch to a byte array form.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>byte array of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(boolean,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(boolean ordered, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</span></div> +<div class="block">Serialize this sketch to a byte array form.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ordered</code> - if true the base buffer will be ordered (default == false).</dd> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>this sketch in a byte array form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>a summary of the key parameters of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean withLevels, + boolean withLevelsAndItems)</span></div> +<div class="block">Returns human readable summary information about this sketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>withLevels</code> - if true includes sketch levels array summary information</dd> +<dd><code>withLevelsAndItems</code> - if true include detail of levels array and items array together</dd> +<dt>Returns:</dt> +<dd>human readable summary information about this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of an ItemsSketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of an ItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of an ItemsSketch. + Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of an ItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="downSample(int)"> +<h3>downSample</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">downSample</span><wbr><span class="parameters">(int newK)</span></div> +<div class="block">From an existing sketch, this creates a new sketch that can have a smaller K. + The original sketch is not modified.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>newK</code> - the new K that must be smaller than current K. + It is required that this.getK() = newK * 2^(nonnegative integer).</dd> +<dt>Returns:</dt> +<dd>the new sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putMemory(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>putMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>> serDe)</span></div> +<div class="block">Puts the current sketch into the given Memory if there is sufficient space. + Otherwise, throws an error.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the given memory.</dd> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a> item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#update(T)">QuantilesGenericAPI</a></code></span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#update(T)">update</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of items. Nulls are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></span> <span class="element-name">getSortedView</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericAPI.html#getSortedView()">QuantilesGenericAPI</a></code></span></div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/ItemsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantiles/ItemsSketchIterator.html new file mode 100644 index 000000000..b48feaea6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/ItemsSketchIterator.html @@ -0,0 +1,201 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ItemsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: ItemsSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ItemsSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class ItemsSketchIterator" class="title">Class ItemsSketchIterator<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.ItemsSketchIterator<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - type of item</dd> +</dl> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></code>, <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ItemsSketchIterator<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></span></div> +<div class="block">Iterator over ItemsSketch. The order is not defined.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketchIterator.html" title="type parameter in ItemsSketchIterator">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the generic quantile at the current index.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWeight()" class="member-name-link">getWeight</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the natural weight at the current index.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Advances the index and checks if it is valid.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketchIterator.html" title="type parameter in ItemsSketchIterator">T</a></span> <span class="element-name">getQuantile</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesGenericSketchIterator.html#getQuantile()">QuantilesGenericSketchIterator</a></code></span></div> +<div class="block">Gets the generic quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesGenericSketchIterator.html#getQuantile()">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="ItemsSketchIterator.html" title="type parameter in ItemsSketchIterator">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the generic quantile at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getWeight()"> +<h3>getWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getWeight</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Gets the natural weight at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the natural weight at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Advances the index and checks if it is valid. + The state of this iterator is undefined before the first call of this method.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>true if the next index is valid.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/ItemsUnion.html b/docs/7.0.X/org/apache/datasketches/quantiles/ItemsUnion.html new file mode 100644 index 000000000..bb93262bd --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/ItemsUnion.html @@ -0,0 +1,474 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ItemsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: ItemsUnion"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ItemsUnion.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class ItemsUnion" class="title">Class ItemsUnion<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantiles.ItemsUnion<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - type of item</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ItemsUnion<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The API for Union operations for generic ItemsSketches</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Alexander Saydakov</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEffectiveK()" class="member-name-link">getEffectiveK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the effective <i>k</i> of this Union.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.Class,int,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + int maxK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create an instance of ItemsUnion</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.Class,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create an instance of ItemsUnion with the default k</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given srcMem into a Union object.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(org.apache.datasketches.quantiles.ItemsSketch)" class="member-name-link">getInstance</a><wbr>(<a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T> sketch)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Create an instance of ItemsUnion based on ItemsSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxK()" class="member-name-link">getMaxK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the configured <i>maxK</i> of this Union.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of this Union operation as a copy of the internal state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResultAndReset()" class="member-name-link">getResultAndReset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of this Union operation (without a copy) and resets this Union to the + virgin state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this union is direct</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this union is empty</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this Union to a virgin state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize this union to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns summary information about the backing sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean)" class="member-name-link">toString</a><wbr>(boolean sketchSummary, + boolean dataDetail)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns summary information about the backing sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">union</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.quantiles.ItemsSketch)" class="member-name-link">union</a><wbr>(<a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> sketchIn)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a> dataItem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this union with the given dataItem.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getInstance(java.lang.Class,java.util.Comparator)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</span></div> +<div class="block">Create an instance of ItemsUnion with the default k</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>clazz</code> - The sketch class type</dd> +<dd><code>comparator</code> - to compare items</dd> +<dt>Returns:</dt> +<dd>an instance of ItemsUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getInstance(java.lang.Class,int,java.util.Comparator)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + int maxK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</span></div> +<div class="block">Create an instance of ItemsUnion</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>clazz</code> - The sketch class type</dd> +<dd><code>maxK</code> - determines the accuracy and size of the union and is a maximum. + The effective <i>k</i> can be smaller due to unions with smaller <i>k</i> sketches. + It is recommended that <i>maxK</i> be a power of 2 to enable unioning of sketches with a + different <i>k</i>.</dd> +<dd><code>comparator</code> - to compare items</dd> +<dt>Returns:</dt> +<dd>an instance of ItemsUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Heapify the given srcMem into a Union object.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>clazz</code> - The sketch class type + A reference to srcMem will not be maintained internally.</dd> +<dd><code>srcMem</code> - the given srcMem.</dd> +<dd><code>comparator</code> - to compare items</dd> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>an instance of ItemsUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getInstance(org.apache.datasketches.quantiles.ItemsSketch)"> +<h3>getInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T> sketch)</span></div> +<div class="block">Create an instance of ItemsUnion based on ItemsSketch</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +<dt>Parameters:</dt> +<dd><code>sketch</code> - the basis of the union</dd> +<dt>Returns:</dt> +<dd>an instance of ItemsUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.quantiles.ItemsSketch)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> sketchIn)</span></div> +<div class="block">Iterative union operation, which means this method can be repeatedly called. + Merges the given sketch into this union object. + The given sketch is not modified. + It is required that the ratio of the two K's be a power of 2. + This is easily satisfied if each of the K's are already a power of 2. + If the given sketch is null or empty it is ignored. + + <p>It is required that the results of the union operation, which can be obtained at any time, + is obtained from <a href="#getResult()"><code>getResult()</code></a>.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - the sketch to be merged into this one.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</span></div> +<div class="block">Iterative union operation, which means this method can be repeatedly called. + Merges the given Memory image of a ItemsSketch into this union object. + The given Memory object is not modified and a link to it is not retained. + It is required that the ratio of the two K's be a power of 2. + This is easily satisfied if each of the K's are already a power of 2. + If the given sketch is null or empty it is ignored. + + <p>It is required that the results of the union operation, which can be obtained at any time, + is obtained from <a href="#getResult()"><code>getResult()</code></a>.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Memory image of sketch to be merged</dd> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a> dataItem)</span></div> +<div class="block">Update this union with the given dataItem.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dataItem</code> - The given datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the result of this Union operation as a copy of the internal state. + This enables further union update operations on this state.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of this Union operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResultAndReset()"> +<h3>getResultAndReset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></span> <span class="element-name">getResultAndReset</span>()</div> +<div class="block">Gets the result of this Union operation (without a copy) and resets this Union to the + virgin state.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of this Union operation and reset.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this Union to a virgin state. + Keeps maxK, comparator and clazz</div> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if this union is empty</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this union is empty</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block">Returns true if this union is direct</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this union is direct</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxK()"> +<h3>getMaxK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxK</span>()</div> +<div class="block">Returns the configured <i>maxK</i> of this Union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the configured <i>maxK</i> of this Union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEffectiveK()"> +<h3>getEffectiveK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getEffectiveK</span>()</div> +<div class="block">Returns the effective <i>k</i> of this Union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the effective <i>k</i> of this Union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns summary information about the backing sketch.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean sketchSummary, + boolean dataDetail)</span></div> +<div class="block">Returns summary information about the backing sketch. Used for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchSummary</code> - if true includes sketch summary</dd> +<dd><code>dataDetail</code> - if true includes data detail</dd> +<dt>Returns:</dt> +<dd>summary information about the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</span></div> +<div class="block">Serialize this union to a byte array. Result is an ItemsSketch, serialized in an + unordered, non-compact form. The resulting byte[] can be passed to getInstance for either a + sketch or union.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>byte array of this union</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/UpdateDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/UpdateDoublesSketch.html new file mode 100644 index 000000000..003be5e82 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/UpdateDoublesSketch.html @@ -0,0 +1,238 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UpdateDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles, class: UpdateDoublesSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UpdateDoublesSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantiles</a></div> +<h1 title="Class UpdateDoublesSketch" class="title">Class UpdateDoublesSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">org.apache.datasketches.quantiles.DoublesSketch</a> +<div class="inheritance">org.apache.datasketches.quantiles.UpdateDoublesSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">UpdateDoublesSketch</span> +<span class="extends-implements">extends <a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a compact version of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Updates this sketch with the given double data item</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap this sketch around the given non-compact Memory image of a DoublesSketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantiles.DoublesSketch">Methods inherited from class org.apache.datasketches.quantiles.<a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></h3> +<code><a href="DoublesSketch.html#builder()">builder</a>, <a href="DoublesSketch.html#downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)">downSample</a>, <a href="DoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a>, <a href="DoublesSketch.html#getCompactSerialiedSizeBytes(int,long)">getCompactSerialiedSizeBytes</a>, <a href="DoublesSketch.html#getCurrentCompactSerializedSizeBytes()">getCurrentCompactSerializedSizeBytes</a>, <a href="DoublesSketch.html#getCurrentUpdatableSerializedSizeBytes()">getCurrentUpdatableSerializedSizeBytes</a>, <a href="DoublesSketch.html#getK()">getK</a>, <a href="DoublesSketch.html#getKFromEpsilon(double,boolean)">getKFromEpsilon</a>, <a href="DoublesSketch.html#getMaxItem()">getMaxItem</a>, <a href="DoublesSketch.html#getMinItem()">getMinItem</a>, <a href="DoublesSketch.html#getN()">getN</a>, <a href="DoublesSketch.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="DoublesSketch.html#getNormalizedRankError(int,boolean)">getNormalizedRankError</a>, <a href="DoublesSketch.html#getNumRetained()">getNumRetained</a>, <a href="DoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a>, <a href="DoublesSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a>, <a href="DoublesSketch.html#getQuantileLowerBound(double)">getQuantileLowerBound</a>, <a href="DoublesSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a>, <a href="DoublesSketch.html#getQuantileUpperBound(double)">getQuantileUpperBound</a>, <a href="DoublesSketch.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a>, <a href="DoublesSketch.html#getRankLowerBound(double)">getRankLowerBound</a>, <a href="DoublesSketch.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a>, <a href="DoublesSketch.html#getRankUpperBound(double)">getRankUpperBound</a>, <a href="DoublesSketch.html#getSerializedSizeBytes()">getSerializedSizeBytes</a>, <a href="DoublesSketch.html#getSortedView()">getSortedView</a>, <a href="DoublesSketch.html#getUpdatableStorageBytes(int,long)">getUpdatableStorageBytes</a>, <a href="DoublesSketch.html#hasMemory()">hasMemory</a>, <a href="DoublesSketch.html#isDirect()">isDirect</a>, <a href="DoublesSketch.html#isEmpty()">isEmpty</a>, <a href="DoublesSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="DoublesSketch.html#isReadOnly()">isReadOnly</a>, <a href="DoublesSketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="DoublesSketch.html#iterator()">iterator</a>, <a href="DoublesSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory)">putMemory</a>, <a href="DoublesSketch.html#putMemory(org.apache.datasketches.memory.WritableMemory,boolean)">putMemory</a>, <a href="DoublesSketch.html#reset()">reset</a>, <a href="DoublesSketch.html#toByteArray()">toByteArray</a>, <a href="DoublesSketch.html#toByteArray(boolean)">toByteArray</a>, <a href="DoublesSketch.html#toString()">toString</a>, <a href="DoublesSketch.html#toString(boolean,boolean)">toString</a>, <a href="DoublesSketch.html#toString(byte%5B%5D)">toString</a>, <a href="DoublesSketch.html#toString(org.apache.datasketches.memory.Memory)">toString</a>, <a href="DoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesDoublesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRank(double)">getRank</a>, <a href="../quantilescommon/QuantilesDoublesAPI.html#getRanks(double%5B%5D)">getRanks</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Wrap this sketch around the given non-compact Memory image of a DoublesSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given Memory image of a DoublesSketch that may have data,</dd> +<dt>Returns:</dt> +<dd>a sketch that wraps the given srcMem</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double item)</span></div> +<div class="block">Updates this sketch with the given double data item</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item from a stream of items. NaNs are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch. + The resulting sketch will not retain any link to the source Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a compact Memory image of a sketch serialized by this sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a heap-based sketch based on the given Memory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></span> <span class="element-name">compact</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a CompactDoublesSketch of this class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact(org.apache.datasketches.memory.WritableMemory)"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></span> <span class="element-name">compact</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns a compact version of this sketch. If passing in a Memory object, the compact sketch + will use that direct memory; otherwise, an on-heap sketch will be returned.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - An optional target memory to hold the sketch.</dd> +<dt>Returns:</dt> +<dd>A compact version of this sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ClassicUtil.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ClassicUtil.html new file mode 100644 index 000000000..23818ded8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ClassicUtil.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.ClassicUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: ClassicUtil"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ClassicUtil.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.ClassicUtil" class="title">Uses of Class<br>org.apache.datasketches.quantiles.ClassicUtil</h1> +</div> +No usage of org.apache.datasketches.quantiles.ClassicUtil</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/CompactDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/CompactDoublesSketch.html new file mode 100644 index 000000000..b4aacf675 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/CompactDoublesSketch.html @@ -0,0 +1,95 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.CompactDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: CompactDoublesSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.CompactDoublesSketch" class="title">Uses of Class<br>org.apache.datasketches.quantiles.CompactDoublesSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateDoublesSketch.</span><code><a href="../UpdateDoublesSketch.html#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateDoublesSketch.</span><code><a href="../UpdateDoublesSketch.html#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a compact version of this sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketch.html new file mode 100644 index 000000000..f03dd0467 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketch.html @@ -0,0 +1,141 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.DoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: DoublesSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.DoublesSketch" class="title">Uses of Class<br>org.apache.datasketches.quantiles.DoublesSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Subclasses of <a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../CompactDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../UpdateDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-last odd-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../DoublesSketch.html#downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">downSample</a><wbr>(<a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> srcSketch, + int smallerK, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">From an source sketch, create a new sketch that must have a smaller K.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../DoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../DoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap this sketch around the given Memory image of a DoublesSketch, compact or updatable.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> with parameters of type <a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../DoublesSketch.html#downSample(org.apache.datasketches.quantiles.DoublesSketch,int,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">downSample</a><wbr>(<a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> srcSketch, + int smallerK, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">From an source sketch, create a new sketch that must have a smaller K.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#heapify(org.apache.datasketches.quantiles.DoublesSketch)" class="member-name-link">heapify</a><wbr>(<a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> sketch)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given sketch.</div> +</div> +<div class="col-first even-row-color"><code>abstract void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#union(org.apache.datasketches.quantiles.DoublesSketch)" class="member-name-link">union</a><wbr>(<a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> sketchIn)</code></div> +<div class="col-last even-row-color"> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketchBuilder.html new file mode 100644 index 000000000..4bf621c13 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketchBuilder.html @@ -0,0 +1,97 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.DoublesSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: DoublesSketchBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.DoublesSketchBuilder" class="title">Uses of Class<br>org.apache.datasketches.quantiles.DoublesSketchBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="../DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../DoublesSketch.html#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a new builder</div> +</div> +<div class="col-first odd-row-color"><code><a href="../DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesSketchBuilder.</span><code><a href="../DoublesSketchBuilder.html#setK(int)" class="member-name-link">setK</a><wbr>(int k)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the parameter <i>k</i> that determines the accuracy and size of the sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketchIterator.html new file mode 100644 index 000000000..d618cf2c7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesSketchIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.DoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: DoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.DoublesSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.quantiles.DoublesSketchIterator</h1> +</div> +No usage of org.apache.datasketches.quantiles.DoublesSketchIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesUnion.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesUnion.html new file mode 100644 index 000000000..0357b1395 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesUnion.html @@ -0,0 +1,121 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.DoublesUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: DoublesUnion"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.DoublesUnion" class="title">Uses of Class<br>org.apache.datasketches.quantiles.DoublesUnion</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesUnionBuilder.</span><code><a href="../DoublesUnionBuilder.html#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a new empty Union object with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesUnionBuilder.</span><code><a href="../DoublesUnionBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a new empty Union object with the current configuration of this Builder + and the specified backing destination Memory store.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given memory + image of a sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#heapify(org.apache.datasketches.quantiles.DoublesSketch)" class="member-name-link">heapify</a><wbr>(<a href="../DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> sketch)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a Heap Union object that has been initialized with the data from the given sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a read-only Union object that wraps off-heap data of the given memory image of + a sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an updatable Union object that wraps off-heap data of the given memory image of + a sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesUnionBuilder.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesUnionBuilder.html new file mode 100644 index 000000000..f0e42a1d7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/DoublesUnionBuilder.html @@ -0,0 +1,98 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.DoublesUnionBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: DoublesUnionBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.DoublesUnionBuilder" class="title">Uses of Class<br>org.apache.datasketches.quantiles.DoublesUnionBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a new UnionBuilder</div> +</div> +<div class="col-first odd-row-color"><code><a href="../DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesUnionBuilder.</span><code><a href="../DoublesUnionBuilder.html#setMaxK(int)" class="member-name-link">setMaxK</a><wbr>(int maxK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the parameter <i>masK</i> that determines the maximum size of the sketch that + results from a union and its accuracy.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsSketch.html new file mode 100644 index 000000000..f3cd59588 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsSketch.html @@ -0,0 +1,140 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.ItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: ItemsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.ItemsSketch" class="title">Uses of Class<br>org.apache.datasketches.quantiles.ItemsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="../ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#downSample(int)" class="member-name-link">downSample</a><wbr>(int newK)</code></div> +<div class="col-last even-row-color"> +<div class="block">From an existing sketch, this creates a new sketch that can have a smaller K.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getInstance(java.lang.Class,int,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Obtains a new instance of an ItemsSketch.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getInstance(java.lang.Class,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last even-row-color"> +<div class="block">Obtains a new instance of an ItemsSketch using the DEFAULT_K.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../ItemsSketch.html#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapifies the given srcMem, which must be a Memory image of a ItemsSketch</div> +</div> +<div class="col-first even-row-color"><code><a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="../ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of this Union operation as a copy of the internal state.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="../ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#getResultAndReset()" class="member-name-link">getResultAndReset</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of this Union operation (without a copy) and resets this Union to the + virgin state.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> with parameters of type <a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#getInstance(org.apache.datasketches.quantiles.ItemsSketch)" class="member-name-link">getInstance</a><wbr>(<a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create an instance of ItemsUnion based on ItemsSketch</div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#union(org.apache.datasketches.quantiles.ItemsSketch)" class="member-name-link">union</a><wbr>(<a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="../ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> sketchIn)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterative union operation, which means this method can be repeatedly called.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsSketchIterator.html new file mode 100644 index 000000000..f6b88a05c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsSketchIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.ItemsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: ItemsSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.ItemsSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.quantiles.ItemsSketchIterator</h1> +</div> +No usage of org.apache.datasketches.quantiles.ItemsSketchIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsUnion.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsUnion.html new file mode 100644 index 000000000..5c1e8516c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/ItemsUnion.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.ItemsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: ItemsUnion"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.ItemsUnion" class="title">Uses of Class<br>org.apache.datasketches.quantiles.ItemsUnion</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#getInstance(java.lang.Class,int,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + int maxK, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last even-row-color"> +<div class="block">Create an instance of ItemsUnion</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#getInstance(java.lang.Class,java.util.Comparator)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create an instance of ItemsUnion with the default k</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#getInstance(java.lang.Class,org.apache.datasketches.memory.Memory,java.util.Comparator,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, + org.apache.datasketches.memory.Memory srcMem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given srcMem into a Union object.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsUnion.</span><code><a href="../ItemsUnion.html#getInstance(org.apache.datasketches.quantiles.ItemsSketch)" class="member-name-link">getInstance</a><wbr>(<a href="../ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T> sketch)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Create an instance of ItemsUnion based on ItemsSketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/class-use/UpdateDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/UpdateDoublesSketch.html new file mode 100644 index 000000000..065c699ed --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/class-use/UpdateDoublesSketch.html @@ -0,0 +1,126 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantiles.UpdateDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles, class: UpdateDoublesSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantiles.UpdateDoublesSketch" class="title">Uses of Class<br>org.apache.datasketches.quantiles.UpdateDoublesSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a> in <a href="../package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketchBuilder.</span><code><a href="../DoublesSketchBuilder.html#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an UpdateDoublesSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesSketchBuilder.</span><code><a href="../DoublesSketchBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a quantiles UpdateDoublesSketch with the current configuration of this builder + and the specified backing destination Memory store.</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Places the result of this Union into the provided memory as an UpdateDoublesSketch, + which enables further update operations on the resulting sketch.</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesUnion.</span><code><a href="../DoublesUnion.html#getResultAndReset()" class="member-name-link">getResultAndReset</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of this Union as an UpdateDoublesSketch, which enables further update + operations on the resulting sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateDoublesSketch.</span><code><a href="../UpdateDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Factory heapify takes a compact sketch image in Memory and instantiates an on-heap sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateDoublesSketch.</span><code><a href="../UpdateDoublesSketch.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap this sketch around the given non-compact Memory image of a DoublesSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/package-summary.html b/docs/7.0.X/org/apache/datasketches/quantiles/package-summary.html new file mode 100644 index 000000000..d5184444a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/package-summary.html @@ -0,0 +1,157 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.quantiles (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantiles"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.quantiles" class="title">Package org.apache.datasketches.quantiles</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.quantiles</span></div> +<section class="package-description" id="package-description"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles"><code>DoublesSketch</code></a></li> +<li><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles"><code>ItemsSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ClassicUtil.html" title="class in org.apache.datasketches.quantiles">ClassicUtil</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Utilities for the classic quantiles sketches and independent of the type.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">For building a new quantiles DoublesSketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over DoublesSketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">The API for Union operations for quantiles DoublesSketches</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">For building a new DoublesSketch Union operation.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over ItemsSketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">The API for Union operations for generic ItemsSketches</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> </div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/package-tree.html b/docs/7.0.X/org/apache/datasketches/quantiles/package-tree.html new file mode 100644 index 000000000..67a835df8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/package-tree.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.quantiles Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.quantiles"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.quantiles</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.quantiles.<a href="ClassicUtil.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ClassicUtil</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="DoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a>) +<ul> +<li class="circle">org.apache.datasketches.quantiles.<a href="CompactDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="UpdateDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="DoublesSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="DoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a>)</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="DoublesUnion.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="DoublesUnionBuilder.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T>)</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="ItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><T> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T>)</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="ItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantiles/package-use.html b/docs/7.0.X/org/apache/datasketches/quantiles/package-use.html new file mode 100644 index 000000000..07ee45173 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantiles/package-use.html @@ -0,0 +1,119 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.quantiles (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantiles"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.quantiles" class="title">Uses of Package<br>org.apache.datasketches.quantiles</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.quantiles</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.quantiles</a> used by <a href="package-summary.html">org.apache.datasketches.quantiles</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/CompactDoublesSketch.html#org.apache.datasketches.quantiles">CompactDoublesSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/DoublesSketch.html#org.apache.datasketches.quantiles">DoublesSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first even-row-color"><a href="class-use/DoublesSketchBuilder.html#org.apache.datasketches.quantiles">DoublesSketchBuilder</a></div> +<div class="col-last even-row-color"> +<div class="block">For building a new quantiles DoublesSketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/DoublesUnion.html#org.apache.datasketches.quantiles">DoublesUnion</a></div> +<div class="col-last odd-row-color"> +<div class="block">The API for Union operations for quantiles DoublesSketches</div> +</div> +<div class="col-first even-row-color"><a href="class-use/DoublesUnionBuilder.html#org.apache.datasketches.quantiles">DoublesUnionBuilder</a></div> +<div class="col-last even-row-color"> +<div class="block">For building a new DoublesSketch Union operation.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ItemsSketch.html#org.apache.datasketches.quantiles">ItemsSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ItemsUnion.html#org.apache.datasketches.quantiles">ItemsUnion</a></div> +<div class="col-last even-row-color"> +<div class="block">The API for Union operations for generic ItemsSketches</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdateDoublesSketch.html#org.apache.datasketches.quantiles">UpdateDoublesSketch</a></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/BinarySearch.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/BinarySearch.html new file mode 100644 index 000000000..17c6b5170 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/BinarySearch.html @@ -0,0 +1,243 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BinarySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: BinarySearch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BinarySearch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class BinarySearch" class="title">Class BinarySearch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.BinarySearch</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BinarySearch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Contains common equality binary search algorithms.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BinarySearch</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(double%5B%5D,int,int,double)" class="member-name-link">find</a><wbr>(double[] arr, + int low, + int high, + double v)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the exact double value in the given search range.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(float%5B%5D,int,int,float)" class="member-name-link">find</a><wbr>(float[] arr, + int low, + int high, + float v)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the exact float value in the given search range.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(long%5B%5D,int,int,long)" class="member-name-link">find</a><wbr>(long[] arr, + int low, + int high, + long v)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the exact long value in the given search range.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>BinarySearch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BinarySearch</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="find(float[],int,int,float)"> +<h3>find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(float[] arr, + int low, + int high, + float v)</span></div> +<div class="block">Binary Search for the index of the exact float value in the given search range. + If -1 is returned there are no values in the search range that equals the given value.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The given ordered array to search.</dd> +<dd><code>low</code> - the index of the lowest value of the search range</dd> +<dd><code>high</code> - the index of the highest value of the search range</dd> +<dd><code>v</code> - the value to search for</dd> +<dt>Returns:</dt> +<dd>return the index of the value, if found, otherwise, return -1;</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="find(double[],int,int,double)"> +<h3>find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(double[] arr, + int low, + int high, + double v)</span></div> +<div class="block">Binary Search for the index of the exact double value in the given search range. + If -1 is returned there are no values in the search range that equals the given value.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The given ordered array to search.</dd> +<dd><code>low</code> - the index of the lowest value of the search range</dd> +<dd><code>high</code> - the index of the highest value of the search range</dd> +<dd><code>v</code> - the value to search for</dd> +<dt>Returns:</dt> +<dd>return the index of the value, if found, otherwise, return -1;</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="find(long[],int,int,long)"> +<h3>find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(long[] arr, + int low, + int high, + long v)</span></div> +<div class="block">Binary Search for the index of the exact long value in the given search range. + If -1 is returned there are no values in the search range that equals the given value.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The given ordered array to search.</dd> +<dd><code>low</code> - the index of the lowest value of the search range</dd> +<dd><code>high</code> - the index of the highest value of the search range</dd> +<dd><code>v</code> - the value to search for</dd> +<dt>Returns:</dt> +<dd>return the index of the value, if found, otherwise, return -1;</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html new file mode 100644 index 000000000..2ba90faf1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html @@ -0,0 +1,401 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: DoublesSketchSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesSketchSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class DoublesSketchSortedView" class="title">Class DoublesSketchSortedView</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.DoublesSketchSortedView</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code>, <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DoublesSketchSortedView</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></span></div> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)" class="member-name-link">DoublesSketchSortedView</a><wbr>(double[] quantiles, + long[] cumWeights, + <a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct from elements, also used in testing.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCumulativeWeights()" class="member-name-link">getCumulativeWeights</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the array of cumulative weights from the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by this sorted view.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sorted view is empty.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.DoublesSortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></h3> +<code><a href="DoublesSortedView.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a>, <a href="DoublesSortedView.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(double[],long[],org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)"> +<h3>DoublesSketchSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoublesSketchSortedView</span><wbr><span class="parameters">(double[] quantiles, + long[] cumWeights, + <a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sk)</span></div> +<div class="block">Construct from elements, also used in testing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - sorted array of quantiles</dd> +<dd><code>cumWeights</code> - sorted, monotonically increasing cumulative weights.</dd> +<dd><code>sk</code> - the underlying quantile sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCumulativeWeights()"> +<h3>getCumulativeWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getCumulativeWeights</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getCumulativeWeights()">SortedView</a></code></span></div> +<div class="block">Returns the array of cumulative weights from the sketch. + Also known as the natural ranks, which are the Natural Numbers on the interval [1, N].</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the array of cumulative weights (or natural ranks).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DoublesSortedView.html#getMaxItem()">DoublesSortedView</a></code></span></div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSortedView.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getMinItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DoublesSortedView.html#getMinItem()">DoublesSortedView</a></code></span></div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSortedView.html#getMinItem()">getMinItem</a></code> in interface <code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getN()">SortedView</a></code></span></div> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getN()">getN</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the total number of items presented to the sourcing sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getNumRetained()">SortedView</a></code></span></div> +<div class="block">Gets the number of quantiles retained by this sorted view. + This may be slightly different from the function with the same name when called from the originating sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by this sorted view</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DoublesSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">DoublesSortedView</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DoublesSortedView.html#getQuantiles()">DoublesSortedView</a></code></span></div> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSortedView.html#getQuantiles()">getQuantiles</a></code> in interface <code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an array of all retained quantiles by the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(double quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DoublesSortedView.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">DoublesSortedView</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSortedView.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#isEmpty()">SortedView</a></code></span></div> +<div class="block">Returns true if this sorted view is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#isEmpty()">isEmpty</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sorted view is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="DoublesSortedView.html#iterator()">iterator</a></code> in interface <code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSortedView.html new file mode 100644 index 000000000..169e7f650 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSortedView.html @@ -0,0 +1,384 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: DoublesSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface DoublesSortedView" class="title">Interface DoublesSortedView</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DoublesSortedView</span><span class="extends-implements"> +extends <a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></span></div> +<div class="block">The Sorted View for quantile sketches of primitive type double.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon"><code>SortedView</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></h3> +<code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a>, <a href="SortedView.html#getN()">getN</a>, <a href="SortedView.html#getNumRetained()">getNumRetained</a>, <a href="SortedView.html#isEmpty()">isEmpty</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array of all retained quantiles by the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(double quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html new file mode 100644 index 000000000..e76a1a3e4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoublesSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: DoublesSortedViewIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoublesSortedViewIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class DoublesSortedViewIterator" class="title">Class DoublesSortedViewIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon.SortedViewIterator</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.DoublesSortedViewIterator</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DoublesSortedViewIterator</span> +<span class="extends-implements">extends <a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></span></div> +<div class="block">Iterator over quantile sketches of primitive type <i>double</i>.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double%5B%5D,long%5B%5D)" class="member-name-link">DoublesSortedViewIterator</a><wbr>(double[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedViewIterator">Methods inherited from class org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></h3> +<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank()">getNaturalRank</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank()">getNormalizedRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(double[],long[])"> +<h3>DoublesSortedViewIterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoublesSortedViewIterator</span><wbr><span class="parameters">(double[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles, which must be ordered.</dd> +<dd><code>cumWeights</code> - the given array of cumulative weights, which must be ordered, start with the value one, and + the last value must be equal to N, the total number of items updated to the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html new file mode 100644 index 000000000..67a54ac1e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html @@ -0,0 +1,401 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>FloatsSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: FloatsSketchSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/FloatsSketchSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class FloatsSketchSortedView" class="title">Class FloatsSketchSortedView</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.FloatsSketchSortedView</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code>, <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FloatsSketchSortedView</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></span></div> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(float%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)" class="member-name-link">FloatsSketchSortedView</a><wbr>(float[] quantiles, + long[] cumWeights, + <a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct Sorted View.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCumulativeWeights()" class="member-name-link">getCumulativeWeights</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the array of cumulative weights from the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by this sorted view.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sorted view is empty.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.FloatsSortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></h3> +<code><a href="FloatsSortedView.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a>, <a href="FloatsSortedView.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(float[],long[],org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)"> +<h3>FloatsSketchSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FloatsSketchSortedView</span><wbr><span class="parameters">(float[] quantiles, + long[] cumWeights, + <a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sk)</span></div> +<div class="block">Construct Sorted View.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - sorted array of quantiles</dd> +<dd><code>cumWeights</code> - sorted, monotonically increasing cumulative weights.</dd> +<dd><code>sk</code> - the underlying quantile sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCumulativeWeights()"> +<h3>getCumulativeWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getCumulativeWeights</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getCumulativeWeights()">SortedView</a></code></span></div> +<div class="block">Returns the array of cumulative weights from the sketch. + Also known as the natural ranks, which are the Natural Numbers on the interval [1, N].</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the array of cumulative weights (or natural ranks).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FloatsSortedView.html#getMaxItem()">FloatsSortedView</a></code></span></div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="FloatsSortedView.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getMinItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FloatsSortedView.html#getMinItem()">FloatsSortedView</a></code></span></div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="FloatsSortedView.html#getMinItem()">getMinItem</a></code> in interface <code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getN()">SortedView</a></code></span></div> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getN()">getN</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the total number of items presented to the sourcing sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getNumRetained()">SortedView</a></code></span></div> +<div class="block">Gets the number of quantiles retained by this sorted view. + This may be slightly different from the function with the same name when called from the originating sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by this sorted view</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FloatsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">FloatsSortedView</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="FloatsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FloatsSortedView.html#getQuantiles()">FloatsSortedView</a></code></span></div> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="FloatsSortedView.html#getQuantiles()">getQuantiles</a></code> in interface <code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an array of all retained quantiles by the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(float quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FloatsSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">FloatsSortedView</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="FloatsSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#isEmpty()">SortedView</a></code></span></div> +<div class="block">Returns true if this sorted view is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#isEmpty()">isEmpty</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sorted view is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="FloatsSortedView.html#iterator()">iterator</a></code> in interface <code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSortedView.html new file mode 100644 index 000000000..f7f85596c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSortedView.html @@ -0,0 +1,384 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>FloatsSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: FloatsSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/FloatsSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface FloatsSortedView" class="title">Interface FloatsSortedView</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">FloatsSortedView</span><span class="extends-implements"> +extends <a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></span></div> +<div class="block">The Sorted View for quantiles of primitive type float.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon"><code>SortedView</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></h3> +<code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a>, <a href="SortedView.html#getN()">getN</a>, <a href="SortedView.html#getNumRetained()">getNumRetained</a>, <a href="SortedView.html#isEmpty()">isEmpty</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type">float[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array of all retained quantiles by the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(float quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html new file mode 100644 index 000000000..b2b795dad --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>FloatsSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: FloatsSortedViewIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/FloatsSortedViewIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class FloatsSortedViewIterator" class="title">Class FloatsSortedViewIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon.SortedViewIterator</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.FloatsSortedViewIterator</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">FloatsSortedViewIterator</span> +<span class="extends-implements">extends <a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></span></div> +<div class="block">Iterator over quantile sketches of primitive type <i>float</i>.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(float%5B%5D,long%5B%5D)" class="member-name-link">FloatsSortedViewIterator</a><wbr>(float[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedViewIterator">Methods inherited from class org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></h3> +<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank()">getNaturalRank</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank()">getNormalizedRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(float[],long[])"> +<h3>FloatsSortedViewIterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FloatsSortedViewIterator</span><wbr><span class="parameters">(float[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles, which must be ordered.</dd> +<dd><code>cumWeights</code> - the given array of cumulative weights, which must be ordered, start with the value one, and + the last value must be equal to N, the total number of items updated to the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html new file mode 100644 index 000000000..7b960c49a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html @@ -0,0 +1,320 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>GenericInequalitySearch.Inequality (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: GenericInequalitySearch, enum: Inequality"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/GenericInequalitySearch.Inequality.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Enum Class GenericInequalitySearch.Inequality" class="title">Enum Class GenericInequalitySearch.Inequality</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a>> +<div class="inheritance">org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="GenericInequalitySearch.html" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">GenericInequalitySearch.Inequality</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a>></span></div> +<div class="block">The enumerator of inequalities</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#EQ" class="member-name-link">EQ</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#GE" class="member-name-link">GE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A < V ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +<div class="col-first even-row-color"><code><a href="#GT" class="member-name-link">GT</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#LE" class="member-name-link">LE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +<div class="col-first even-row-color"><code><a href="#LT" class="member-name-link">LT</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>v</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A < v ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="LT"> +<h3>LT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span> <span class="element-name">LT</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>v</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A < v ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> > arr[high], return arr[high].<br> + If <i>v</i> ≤ arr[low], return -1.<br> + Else return index of A.</p></div> +</section> +</li> +<li> +<section class="detail" id="LE"> +<h3>LE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span> <span class="element-name">LE</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> ≥ arr[high], return arr[high].<br> + If <i>v</i> < arr[low], return -1.<br> + Else return index of A.</p></div> +</section> +</li> +<li> +<section class="detail" id="EQ"> +<h3>EQ</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span> <span class="element-name">EQ</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>. + The returned value from the binary search algorithm will be the index of <i>A</i> or <i>B</i>, + if one of them is equal to <i>V</i>, or -1 if V is not equal to either one.</div> +</section> +</li> +<li> +<section class="detail" id="GE"> +<h3>GE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span> <span class="element-name">GE</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A < V ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> ≤ arr[low], return arr[low].<br> + If <i>v</i> > arr[high], return -1.<br> + Else return index of B.</p></div> +</section> +</li> +<li> +<section class="detail" id="GT"> +<h3>GT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span> <span class="element-name">GT</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> < arr[low], return arr[low].<br> + If <i>v</i> ≥ arr[high], return -1.<br> + Else return index of B.</p></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericInequalitySearch.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericInequalitySearch.html new file mode 100644 index 000000000..77742df1f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericInequalitySearch.html @@ -0,0 +1,238 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>GenericInequalitySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: GenericInequalitySearch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/GenericInequalitySearch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class GenericInequalitySearch" class="title">Class GenericInequalitySearch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.GenericInequalitySearch</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">GenericInequalitySearch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values. The inequality criteria include + <, ≤, ==, ≥, >. All the inequality criteria use the same search algorithm. + (Although == is not an inequality, it is included for convenience.) + + <p>In order to make the searching unique and unambiguous, we modified the traditional binary + search algorithm to search for adjacent pairs of values <i>{A, B}</i> in the values array + instead of just a single value, where <i>a</i> and <i>b</i> are the array indices of two + adjacent values in the array. For all the search criteria, when the algorithm has narrowed the + search down to a single value or adjacent pair of values, the <i>resolve()</i> method provides the + final result of the search. If there is no valid value in the array that satisfies the search + criterion, the algorithm will return -1 to the caller.</p> + + <p>Given a sorted array of values <i>arr[]</i> and a search key value <i>v</i>, the algorithms for + the searching criteria are given with each enum criterion.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="https://datasketches.apache.org/docs/QuantilesAll/SketchingQuantilesAndRanksTutorial.html"> + Sketching Quantiles and Ranks Tutorial</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="GenericInequalitySearch.Inequality.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The enumerator of inequalities</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">GenericInequalitySearch</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(T%5B%5D,int,int,T,org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality,java.util.Comparator)" class="member-name-link">find</a><wbr>(T[] arr, + int low, + int high, + T v, + <a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a> crit, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><T> comparator)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the generic value in the given search range that satisfies + the given Inequality criterion.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>GenericInequalitySearch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GenericInequalitySearch</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="find(T[],int,int,T,org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality,java.util.Comparator)"> +<h3 id="find(java.lang.Object[],int,int,java.lang.Object,org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality,java.util.Comparator)">find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(T[] arr, + int low, + int high, + T v, + <a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a> crit, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><T> comparator)</span></div> +<div class="block">Binary Search for the index of the generic value in the given search range that satisfies + the given Inequality criterion. + If -1 is returned there are no values in the search range that satisfy the inequality.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The generic type of value to be used in the search process.</dd> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given array of comparable values that must be sorted. + The array must not be null or empty and the values of the array must not be null (or NaN) + in the range [low, high].</dd> +<dd><code>low</code> - the lowest index of the lowest value in the search range, inclusive.</dd> +<dd><code>high</code> - the highest index of the highest value in the search range, inclusive.</dd> +<dd><code>v</code> - the value to search for. It must not be null (or NaN).</dd> +<dd><code>crit</code> - one of the Inequality criteria: LT, LE, EQ, GE, GT. It must not be null.</dd> +<dd><code>comparator</code> - for the type T. + It must not be null. It must return: -1 if A < B, 0 if A == B, and +1 if A > B.</dd> +<dt>Returns:</dt> +<dd>the index of the value in the given search range that satisfies the Inequality criterion.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html new file mode 100644 index 000000000..c0f4c9fb5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html @@ -0,0 +1,364 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>GenericPartitionBoundaries (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: GenericPartitionBoundaries"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/GenericPartitionBoundaries.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class GenericPartitionBoundaries" class="title">Class GenericPartitionBoundaries<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.GenericPartitionBoundaries<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">GenericPartitionBoundaries<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(long,T%5B%5D,long%5B%5D,double%5B%5D,T,T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">GenericPartitionBoundaries</a><wbr>(long totalN, + <a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a>[] boundaries, + long[] natRanks, + double[] normRanks, + <a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a> maxItem, + <a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a> minItem, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBoundaries()" class="member-name-link">getBoundaries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an ordered array of boundaries that sequentially define the upper and lower boundaries of partitions.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the length of the input stream offered to the underlying sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNaturalRanks()" class="member-name-link">getNaturalRanks</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an ordered array of natural ranks of the associated array of partition boundaries utilizing + a specified search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNormalizedRanks()" class="member-name-link">getNormalizedRanks</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an ordered array of normalized ranks of the associated array of partition boundaries utilizing + a specified search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumDeltaItems()" class="member-name-link">getNumDeltaItems</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of items to be included for each partition as an array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumPartitions()" class="member-name-link">getNumPartitions</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of partitions</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSearchCriteria()" class="member-name-link">getSearchCriteria</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the search criteria specified for the source sketch</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(long,T[],long[],double[],T,T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="<init>(long,java.lang.Object[],long[],double[],java.lang.Object,java.lang.Object,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">GenericPartitionBoundaries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GenericPartitionBoundaries</span><wbr><span class="parameters">(long totalN, + <a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a>[] boundaries, + long[] natRanks, + double[] normRanks, + <a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a> maxItem, + <a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a> minItem, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>totalN</code> - the total number of items input to the sketch.</dd> +<dd><code>boundaries</code> - The quantile boundaries between partitions</dd> +<dd><code>natRanks</code> - The array of natural Ranks corresponding to the array of boundaries.</dd> +<dd><code>normRanks</code> - The normalized Ranks corresponding to the array of boundaries.</dd> +<dd><code>maxItem</code> - the maximum item of the stream.</dd> +<dd><code>minItem</code> - the minimum item of the stream.</dd> +<dd><code>searchCrit</code> - the user defined search criteria</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Gets the length of the input stream offered to the underlying sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the length of the input stream offered to the underlying sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getBoundaries()"> +<h3>getBoundaries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a>[]</span> <span class="element-name">getBoundaries</span>()</div> +<div class="block">Gets an ordered array of boundaries that sequentially define the upper and lower boundaries of partitions. + These partitions are to be constructed by an external process. Each boundary is essentially a reference and + should uniquely identify an item or a set of identical items from the original stream of data fed to the + originating sketch. + + <p>Assume boundaries array has size N + 1. Let the indicies be sequentially numbered from 0 to N. + The number of partitions is always one less than the size of the boundaries array. + Let the the partitions be sequentially numbered from 1 to N. + + <p>If these results were computed using QuantileSearchCriteria.INCLUSIVE then these sequential boundaries + are to be interpreted as follows: + <ul> + <li>Partition 1: include all items ≥ index 0 and ≤ index 1.</li> + <li>Partition 2: include all items > index 1 and ≤ index 2.</li> + <li>Partition N: include all items > index N-1 and ≤ index N.</li> + </ul> + + <p>If these results were computed using QuantileSearchCriteria.EXCLUSIVE then these sequential boundaries + are to be interpreted as follows: + <ul> + <li>Partition 1: include all items ≥ index 0 and < index 1.</li> + <li>Partition 2: include all items ≥ index 1 and < index 2.</li> + <li>Partition N: include all items ≥ index N-1 and ≤ index N.</li> + </ul></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array of boundaries that sequentially define the upper and lower boundaries of partitions.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNaturalRanks()"> +<h3>getNaturalRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getNaturalRanks</span>()</div> +<div class="block">Gets an ordered array of natural ranks of the associated array of partition boundaries utilizing + a specified search criterion. Natural ranks are integral values on the interval [1, N]</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array of natural ranks.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRanks()"> +<h3>getNormalizedRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getNormalizedRanks</span>()</div> +<div class="block">Gets an ordered array of normalized ranks of the associated array of partition boundaries utilizing + a specified search criterion. Normalized ranks are double values on the interval [0.0, 1.0].</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array of normalized ranks.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumDeltaItems()"> +<h3>getNumDeltaItems</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getNumDeltaItems</span>()</div> +<div class="block">Gets the number of items to be included for each partition as an array. + The count at index 0 is 0. The number of items included in the first partition, defined by the boundaries at + index 0 and index 1, is at index 1 in this array, etc.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of items to be included for each partition as an array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumPartitions()"> +<h3>getNumPartitions</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumPartitions</span>()</div> +<div class="block">Gets the number of partitions</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of partitions</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a></span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a></span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSearchCriteria()"> +<h3>getSearchCriteria</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span> <span class="element-name">getSearchCriteria</span>()</div> +<div class="block">Gets the search criteria specified for the source sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The search criteria specified for the source sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericSortedView.html new file mode 100644 index 000000000..73dafeafb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericSortedView.html @@ -0,0 +1,434 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>GenericSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: GenericSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/GenericSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface GenericSortedView" class="title">Interface GenericSortedView<T></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The generic quantile type.</dd> +</dl> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T></code>, <code><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code>, <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">GenericSortedView<T></span><span class="extends-implements"> +extends <a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, <a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>, <a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></span></div> +<div class="block">The Sorted View for quantiles of generic type.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon"><code>SortedView</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getComparator()" class="member-name-link">getComparator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the Comparator for this generic type.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the full array of quantiles.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a> quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <T> void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#validateItems(T%5B%5D,java.util.Comparator)" class="member-name-link">validateItems</a><wbr>(T[] items, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> +<div class="block">Checks the sequential validity of the given array of generic items.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.PartitioningFeature">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></h3> +<code><a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)">getPartitionBoundariesFromNumParts</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromNumParts</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)">getPartitionBoundariesFromPartSize</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromPartSize</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SketchPartitionLimits">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></h3> +<code><a href="SketchPartitionLimits.html#getMaxPartitions()">getMaxPartitions</a>, <a href="SketchPartitionLimits.html#getMinPartitionSizeItems()">getMinPartitionSizeItems</a>, <a href="SketchPartitionLimits.html#getN()">getN</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></h3> +<code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a>, <a href="SortedView.html#getN()">getN</a>, <a href="SortedView.html#getNumRetained()">getNumRetained</a>, <a href="SortedView.html#isEmpty()">isEmpty</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getCDF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>If the sketch is empty this returns null.</p> + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getComparator()"> +<h3>getComparator</h3> +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>></span> <span class="element-name">getComparator</span>()</div> +<div class="block">Gets the Comparator for this generic type.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Comparator for this generic type.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type"><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a></span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type"><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a></span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getPMF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type"><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a></span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type"><a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block">Returns the full array of quantiles.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the full array of quantiles.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRank(java.lang.Object,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a> quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="GenericSortedView.html" title="type parameter in GenericSortedView">T</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="validateItems(T[],java.util.Comparator)"> +<h3 id="validateItems(java.lang.Object[],java.util.Comparator)">validateItems</h3> +<div class="member-signature"><span class="modifiers">static</span> <span class="type-parameters"><T></span> <span class="return-type">void</span> <span class="element-name">validateItems</span><wbr><span class="parameters">(T[] items, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</span></div> +<div class="block">Checks the sequential validity of the given array of generic items. + They must be unique, monotonically increasing and not null.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the data type</dd> +<dt>Parameters:</dt> +<dd><code>items</code> - given array of generic items</dd> +<dd><code>comparator</code> - the comparator for generic item data type T</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html new file mode 100644 index 000000000..b7c20dca0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html @@ -0,0 +1,220 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>GenericSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: GenericSortedViewIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/GenericSortedViewIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class GenericSortedViewIterator" class="title">Class GenericSortedViewIterator<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon.SortedViewIterator</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.GenericSortedViewIterator<T></div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The generic item class type</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">GenericSortedViewIterator<T></span> +<span class="extends-implements">extends <a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></span></div> +<div class="block">Iterator over quantile sketches of generic type.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(T%5B%5D,long%5B%5D)" class="member-name-link">GenericSortedViewIterator</a><wbr>(<a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a>[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the quantile at the current index + This is equivalent to <i>getQuantile(INCLUSIVE)</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the quantile at the current index (or previous index) + based on the chosen search criterion.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedViewIterator">Methods inherited from class org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></h3> +<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank()">getNaturalRank</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank()">getNormalizedRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(T[],long[])"> +<h3 id="<init>(java.lang.Object[],long[])">GenericSortedViewIterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GenericSortedViewIterator</span><wbr><span class="parameters">(<a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a>[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>cumWeights</code> - the array of cumulative weights, corresponding to the array of quantiles, + starting with the value one and the end value must equal N, the total number of items input to the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the quantile at the current index + This is equivalent to <i>getQuantile(INCLUSIVE)</i>. + + <p>Don't call this before calling next() for the first time or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the quantile at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the quantile at the current index (or previous index) + based on the chosen search criterion. + + <p>Don't call this before calling next() for the first time or after getting false from next().</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>searchCrit</code> - if INCLUSIVE, includes the quantile at the current index. + Otherwise, returns the quantile of the previous index.</dd> +<dt>Returns:</dt> +<dd>the quantile at the current index (or previous index) + based on the chosen search criterion. If the chosen search criterion is <i>EXCLUSIVE</i> and + the current index is at zero, this will return <i>null</i>.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html new file mode 100644 index 000000000..24fe6e90b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html @@ -0,0 +1,191 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IncludeMinMax.DoublesPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: DoublesPair"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IncludeMinMax.DoublesPair.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class IncludeMinMax.DoublesPair" class="title">Class IncludeMinMax.DoublesPair</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.IncludeMinMax.DoublesPair</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">IncludeMinMax.DoublesPair</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A simple structure to hold a pair of arrays</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>long[]</code></div> +<div class="col-second even-row-color"><code><a href="#cumWeights" class="member-name-link">cumWeights</a></code></div> +<div class="col-last even-row-color"> +<div class="block">the array of associated cumulative weights</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><code><a href="#quantiles" class="member-name-link">quantiles</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">the array of quantiles</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double%5B%5D,long%5B%5D)" class="member-name-link">DoublesPair</a><wbr>(double[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="quantiles"> +<h3>quantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">quantiles</span></div> +<div class="block">the array of quantiles</div> +</section> +</li> +<li> +<section class="detail" id="cumWeights"> +<h3>cumWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">cumWeights</span></div> +<div class="block">the array of associated cumulative weights</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(double[],long[])"> +<h3>DoublesPair</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoublesPair</span><wbr><span class="parameters">(double[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the array of quantiles</dd> +<dd><code>cumWeights</code> - the array of associated cumulative weights</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html new file mode 100644 index 000000000..2943dcb26 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html @@ -0,0 +1,191 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IncludeMinMax.FloatsPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: FloatsPair"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IncludeMinMax.FloatsPair.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class IncludeMinMax.FloatsPair" class="title">Class IncludeMinMax.FloatsPair</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.IncludeMinMax.FloatsPair</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">IncludeMinMax.FloatsPair</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A simple structure to hold a pair of arrays</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>long[]</code></div> +<div class="col-second even-row-color"><code><a href="#cumWeights" class="member-name-link">cumWeights</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The array of associated cumulative weights</div> +</div> +<div class="col-first odd-row-color"><code>float[]</code></div> +<div class="col-second odd-row-color"><code><a href="#quantiles" class="member-name-link">quantiles</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The array of quantiles</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(float%5B%5D,long%5B%5D)" class="member-name-link">FloatsPair</a><wbr>(float[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="quantiles"> +<h3>quantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float[]</span> <span class="element-name">quantiles</span></div> +<div class="block">The array of quantiles</div> +</section> +</li> +<li> +<section class="detail" id="cumWeights"> +<h3>cumWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">cumWeights</span></div> +<div class="block">The array of associated cumulative weights</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(float[],long[])"> +<h3>FloatsPair</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FloatsPair</span><wbr><span class="parameters">(float[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the array of quantiles</dd> +<dd><code>cumWeights</code> - the array of associated cumulative weights</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html new file mode 100644 index 000000000..b0468cbb1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html @@ -0,0 +1,195 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IncludeMinMax.ItemsPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: ItemsPair"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IncludeMinMax.ItemsPair.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class IncludeMinMax.ItemsPair" class="title">Class IncludeMinMax.ItemsPair<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.IncludeMinMax.ItemsPair<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">IncludeMinMax.ItemsPair<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A simple structure to hold a pair of arrays</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>long[]</code></div> +<div class="col-second even-row-color"><code><a href="#cumWeights" class="member-name-link">cumWeights</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The array of associated cumulative weights</div> +</div> +<div class="col-first odd-row-color"><code><a href="IncludeMinMax.ItemsPair.html" title="type parameter in IncludeMinMax.ItemsPair">T</a>[]</code></div> +<div class="col-second odd-row-color"><code><a href="#quantiles" class="member-name-link">quantiles</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The array of quantiles</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(T%5B%5D,long%5B%5D)" class="member-name-link">ItemsPair</a><wbr>(<a href="IncludeMinMax.ItemsPair.html" title="type parameter in IncludeMinMax.ItemsPair">T</a>[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="quantiles"> +<h3>quantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IncludeMinMax.ItemsPair.html" title="type parameter in IncludeMinMax.ItemsPair">T</a>[]</span> <span class="element-name">quantiles</span></div> +<div class="block">The array of quantiles</div> +</section> +</li> +<li> +<section class="detail" id="cumWeights"> +<h3>cumWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">cumWeights</span></div> +<div class="block">The array of associated cumulative weights</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(T[],long[])"> +<h3 id="<init>(java.lang.Object[],long[])">ItemsPair</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ItemsPair</span><wbr><span class="parameters">(<a href="IncludeMinMax.ItemsPair.html" title="type parameter in IncludeMinMax.ItemsPair">T</a>[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the array of quantiles</dd> +<dd><code>cumWeights</code> - the array of associated cumulative weights</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html new file mode 100644 index 000000000..276e8b27c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html @@ -0,0 +1,191 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IncludeMinMax.LongsPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: LongsPair"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IncludeMinMax.LongsPair.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class IncludeMinMax.LongsPair" class="title">Class IncludeMinMax.LongsPair</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.IncludeMinMax.LongsPair</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">IncludeMinMax.LongsPair</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A simple structure to hold a pair of arrays</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>long[]</code></div> +<div class="col-second even-row-color"><code><a href="#cumWeights" class="member-name-link">cumWeights</a></code></div> +<div class="col-last even-row-color"> +<div class="block">the array of associated cumulative weights</div> +</div> +<div class="col-first odd-row-color"><code>long[]</code></div> +<div class="col-second odd-row-color"><code><a href="#quantiles" class="member-name-link">quantiles</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">the array of quantiles</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(long%5B%5D,long%5B%5D)" class="member-name-link">LongsPair</a><wbr>(long[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="quantiles"> +<h3>quantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">quantiles</span></div> +<div class="block">the array of quantiles</div> +</section> +</li> +<li> +<section class="detail" id="cumWeights"> +<h3>cumWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">cumWeights</span></div> +<div class="block">the array of associated cumulative weights</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(long[],long[])"> +<h3>LongsPair</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LongsPair</span><wbr><span class="parameters">(long[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the array of quantiles</dd> +<dd><code>cumWeights</code> - the array of associated cumulative weights</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.html new file mode 100644 index 000000000..ee27af328 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/IncludeMinMax.html @@ -0,0 +1,300 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IncludeMinMax (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IncludeMinMax.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class IncludeMinMax" class="title">Class IncludeMinMax</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.IncludeMinMax</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">IncludeMinMax</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class reinserts the min and max values into the sorted view arrays as required.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static class </code></div> +<div class="col-second even-row-color"><code><a href="IncludeMinMax.DoublesPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color"><code>static class </code></div> +<div class="col-second odd-row-color"><code><a href="IncludeMinMax.FloatsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first even-row-color"><code>static class </code></div> +<div class="col-second even-row-color"><code><a href="IncludeMinMax.ItemsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><<a href="IncludeMinMax.ItemsPair.html" title="type parameter in IncludeMinMax.ItemsPair">T</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color"><code>static class </code></div> +<div class="col-second odd-row-color"><code><a href="IncludeMinMax.LongsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">IncludeMinMax</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#includeDoublesMinMax(double%5B%5D,long%5B%5D,double,double)" class="member-name-link">includeDoublesMinMax</a><wbr>(double[] quantilesIn, + long[] cumWeightsIn, + double maxItem, + double minItem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The logic to include the min and max of type double.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#includeFloatsMinMax(float%5B%5D,long%5B%5D,float,float)" class="member-name-link">includeFloatsMinMax</a><wbr>(float[] quantilesIn, + long[] cumWeightsIn, + float maxItem, + float minItem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The logic to include the min and max of type float.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#includeItemsMinMax(T%5B%5D,long%5B%5D,T,T,java.util.Comparator)" class="member-name-link">includeItemsMinMax</a><wbr>(T[] quantilesIn, + long[] cumWeightsIn, + T maxItem, + T minItem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The logic to include the min and max of type T.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#includeLongsMinMax(long%5B%5D,long%5B%5D,long,long)" class="member-name-link">includeLongsMinMax</a><wbr>(long[] quantilesIn, + long[] cumWeightsIn, + long maxItem, + long minItem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The logic to include the min and max of type double.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>IncludeMinMax</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IncludeMinMax</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="includeDoublesMinMax(double[],long[],double,double)"> +<h3>includeDoublesMinMax</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></span> <span class="element-name">includeDoublesMinMax</span><wbr><span class="parameters">(double[] quantilesIn, + long[] cumWeightsIn, + double maxItem, + double minItem)</span></div> +<div class="block">The logic to include the min and max of type double.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantilesIn</code> - The array of quantiles</dd> +<dd><code>cumWeightsIn</code> - The array of associated cumulative weights</dd> +<dd><code>maxItem</code> - the maximum item of the stream</dd> +<dd><code>minItem</code> - the minimum item of the stream</dd> +<dt>Returns:</dt> +<dd>a DoublesPair</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="includeLongsMinMax(long[],long[],long,long)"> +<h3>includeLongsMinMax</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></span> <span class="element-name">includeLongsMinMax</span><wbr><span class="parameters">(long[] quantilesIn, + long[] cumWeightsIn, + long maxItem, + long minItem)</span></div> +<div class="block">The logic to include the min and max of type double.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantilesIn</code> - The array of quantiles</dd> +<dd><code>cumWeightsIn</code> - The array of associated cumulative weights</dd> +<dd><code>maxItem</code> - the maximum item of the stream</dd> +<dd><code>minItem</code> - the minimum item of the stream</dd> +<dt>Returns:</dt> +<dd>a DoublesPair</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="includeFloatsMinMax(float[],long[],float,float)"> +<h3>includeFloatsMinMax</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></span> <span class="element-name">includeFloatsMinMax</span><wbr><span class="parameters">(float[] quantilesIn, + long[] cumWeightsIn, + float maxItem, + float minItem)</span></div> +<div class="block">The logic to include the min and max of type float.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantilesIn</code> - The array of quantiles</dd> +<dd><code>cumWeightsIn</code> - The array of associated cumulative weights</dd> +<dd><code>maxItem</code> - the maximum item of the stream</dd> +<dd><code>minItem</code> - the minimum item of the stream</dd> +<dt>Returns:</dt> +<dd>a FloatsPair</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="includeItemsMinMax(T[],long[],T,T,java.util.Comparator)"> +<h3 id="includeItemsMinMax(java.lang.Object[],long[],java.lang.Object,java.lang.Object,java.util.Comparator)">includeItemsMinMax</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><T></span> <span class="element-name">includeItemsMinMax</span><wbr><span class="parameters">(T[] quantilesIn, + long[] cumWeightsIn, + T maxItem, + T minItem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</span></div> +<div class="block">The logic to include the min and max of type T.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +<dt>Parameters:</dt> +<dd><code>quantilesIn</code> - The array of quantiles</dd> +<dd><code>cumWeightsIn</code> - The array of associated cumulative weights</dd> +<dd><code>maxItem</code> - the maximum item of the stream</dd> +<dd><code>minItem</code> - the minimum item of the stream</dd> +<dd><code>comparator</code> - a comparator for type T</dd> +<dt>Returns:</dt> +<dd>an ItemsPair</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/InequalitySearch.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/InequalitySearch.html new file mode 100644 index 000000000..9714a2451 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/InequalitySearch.html @@ -0,0 +1,599 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>InequalitySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, enum: InequalitySearch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/InequalitySearch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Enum Class InequalitySearch" class="title">Enum Class InequalitySearch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a>> +<div class="inheritance">org.apache.datasketches.quantilescommon.InequalitySearch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">InequalitySearch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a>></span></div> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values. The inequality criteria include + <, ≤, ==, ≥, >. All the inequality criteria use the same search algorithm. + (Although == is not an inequality, it is included for convenience.) + + <p>In order to make the searching unique and unambiguous, we modified the traditional binary + search algorithm to search for adjacent pairs of values <i>{A, B}</i> in the values array + instead of just a single value, where <i>a</i> and <i>b</i> are the array indices of two + adjacent values in the array. For all the search criteria, when the algorithm has narrowed the + search down to a single value or adjacent pair of values, the <i>resolve()</i> method provides the + final result of the search. If there is no valid value in the array that satisfies the search + criterion, the algorithm will return -1 to the caller.</p> + + <p>Given a sorted array of values <i>arr[]</i> and a search key value <i>v</i>, the algorithms for + the searching criteria are given with each enum criterion.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="https://datasketches.apache.org/docs/QuantilesAll/SketchingQuantilesAndRanksTutorial.html"> + Sketching Quantiles and Ranks Tutorial</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#EQ" class="member-name-link">EQ</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#GE" class="member-name-link">GE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A < V ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +<div class="col-first even-row-color"><code><a href="#GT" class="member-name-link">GT</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#LE" class="member-name-link">LE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +<div class="col-first even-row-color"><code><a href="#LT" class="member-name-link">LT</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>v</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A < v ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#desc(double%5B%5D,int,int,double,int)" class="member-name-link">desc</a><wbr>(double[] arr, + int low, + int high, + double v, + int idx)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Optional call that describes the details of the results of the search.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#desc(float%5B%5D,int,int,float,int)" class="member-name-link">desc</a><wbr>(float[] arr, + int low, + int high, + float v, + int idx)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Optional call that describes the details of the results of the search.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#desc(long%5B%5D,int,int,double,int)" class="member-name-link">desc</a><wbr>(long[] arr, + int low, + int high, + double v, + int idx)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Optional call that describes the details of the results of the search.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#desc(long%5B%5D,int,int,long,int)" class="member-name-link">desc</a><wbr>(long[] arr, + int low, + int high, + long v, + int idx)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Optional call that describes the details of the results of the search.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(double%5B%5D,int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(double[] arr, + int low, + int high, + double v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(float%5B%5D,int,int,float,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(float[] arr, + int low, + int high, + float v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the float value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(long%5B%5D,int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(long[] arr, + int low, + int high, + double v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#find(long%5B%5D,int,int,long,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(long[] arr, + int low, + int high, + long v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Binary Search for the index of the long value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="LT"> +<h3>LT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span> <span class="element-name">LT</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>v</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A < v ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> > arr[high], return arr[high].<br> + If <i>v</i> ≤ arr[low], return -1.<br> + Else return index of A.</p></div> +</section> +</li> +<li> +<section class="detail" id="LE"> +<h3>LE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span> <span class="element-name">LE</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the highest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> ≥ arr[high], return arr[high].<br> + If <i>v</i> < arr[low], return -1.<br> + Else return index of A.</p></div> +</section> +</li> +<li> +<section class="detail" id="EQ"> +<h3>EQ</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span> <span class="element-name">EQ</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>. + The returned value from the binary search algorithm will be the index of <i>A</i> or <i>B</i>, + if one of them is equal to <i>V</i>, or -1 if V is not equal to either one.</div> +</section> +</li> +<li> +<section class="detail" id="GE"> +<h3>GE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span> <span class="element-name">GE</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A < V ≤ B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> ≤ arr[low], return arr[low].<br> + If <i>v</i> > arr[high], return -1.<br> + Else return index of B.</p></div> +</section> +</li> +<li> +<section class="detail" id="GT"> +<h3>GT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span> <span class="element-name">GT</span></div> +<div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, + this criterion instructs the binary search algorithm to find the lowest adjacent pair of + values <i>{A,B}</i> such that <i>A ≤ V < B</i>.<br> + Let <i>low</i> = index of the lowest value in the range.<br> + Let <i>high</i> = index of the highest value in the range. + + <p>If <i>v</i> < arr[low], return arr[low].<br> + If <i>v</i> ≥ arr[high], return -1.<br> + Else return index of B.</p></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="desc(double[],int,int,double,int)"> +<h3>desc</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">desc</span><wbr><span class="parameters">(double[] arr, + int low, + int high, + double v, + int idx)</span></div> +<div class="block">Optional call that describes the details of the results of the search. + Used primarily for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The underlying sorted array of values</dd> +<dd><code>low</code> - the low index of the range</dd> +<dd><code>high</code> - the high index of the range</dd> +<dd><code>v</code> - the value to search for</dd> +<dd><code>idx</code> - the resolved index from the search</dd> +<dt>Returns:</dt> +<dd>the descriptive string.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="desc(float[],int,int,float,int)"> +<h3>desc</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">desc</span><wbr><span class="parameters">(float[] arr, + int low, + int high, + float v, + int idx)</span></div> +<div class="block">Optional call that describes the details of the results of the search. + Used primarily for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The underlying sorted array of values</dd> +<dd><code>low</code> - the low index of the range</dd> +<dd><code>high</code> - the high index of the range</dd> +<dd><code>v</code> - the value to search for</dd> +<dd><code>idx</code> - the resolved index from the search</dd> +<dt>Returns:</dt> +<dd>the descriptive string.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="desc(long[],int,int,long,int)"> +<h3>desc</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">desc</span><wbr><span class="parameters">(long[] arr, + int low, + int high, + long v, + int idx)</span></div> +<div class="block">Optional call that describes the details of the results of the search. + Used primarily for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The underlying sorted array of values</dd> +<dd><code>low</code> - the low index of the range</dd> +<dd><code>high</code> - the high index of the range</dd> +<dd><code>v</code> - the value to search for</dd> +<dd><code>idx</code> - the resolved index from the search</dd> +<dt>Returns:</dt> +<dd>the descriptive string.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="desc(long[],int,int,double,int)"> +<h3>desc</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">desc</span><wbr><span class="parameters">(long[] arr, + int low, + int high, + double v, + int idx)</span></div> +<div class="block">Optional call that describes the details of the results of the search. + Used primarily for debugging.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The underlying sorted array of values</dd> +<dd><code>low</code> - the low index of the range</dd> +<dd><code>high</code> - the high index of the range</dd> +<dd><code>v</code> - the value to search for</dd> +<dd><code>idx</code> - the resolved index from the search</dd> +<dt>Returns:</dt> +<dd>the descriptive string.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="find(double[],int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)"> +<h3>find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(double[] arr, + int low, + int high, + double v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</span></div> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion. + If -1 is returned there are no values in the search range that satisfy the criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given array of comparable values that must be sorted with increasing values. + The array must not be null and the values of the array must not be NaN in the range [low, high].</dd> +<dd><code>low</code> - the lowest index of the lowest value in the search range, inclusive.</dd> +<dd><code>high</code> - the highest index of the highest value in the search range, inclusive.</dd> +<dd><code>v</code> - the value to search for. It must not be NaN.</dd> +<dd><code>crit</code> - one of the InequalitySearch criteria: LT, LE, EQ, GT, GE. It must not be null.</dd> +<dt>Returns:</dt> +<dd>the index of the value in the given search range that satisfies the InequalitySearch criterion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="find(float[],int,int,float,org.apache.datasketches.quantilescommon.InequalitySearch)"> +<h3>find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(float[] arr, + int low, + int high, + float v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</span></div> +<div class="block">Binary Search for the index of the float value in the given search range that satisfies + the given InequalitySearch criterion. + If -1 is returned there are no values in the search range that satisfy the criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given array that must be sorted. + It must not be null and must not contain any NaN values in the range {low, high} inclusive.</dd> +<dd><code>low</code> - the lowest index of the lowest value in the search range, inclusive.</dd> +<dd><code>high</code> - the highest index of the highest value in the search range, inclusive.</dd> +<dd><code>v</code> - the value to search for. It must not be NaN.</dd> +<dd><code>crit</code> - one of LT, LE, EQ, GT, GE</dd> +<dt>Returns:</dt> +<dd>the index of the value in the given search range that satisfies the criterion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="find(long[],int,int,long,org.apache.datasketches.quantilescommon.InequalitySearch)"> +<h3>find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(long[] arr, + int low, + int high, + long v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</span></div> +<div class="block">Binary Search for the index of the long value in the given search range that satisfies + the given InequalitySearch criterion. + If -1 is returned there are no values in the search range that satisfy the criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given array that must be sorted.</dd> +<dd><code>low</code> - the lowest index of the lowest value in the search range, inclusive.</dd> +<dd><code>high</code> - the highest index of the highest value in the search range, inclusive.</dd> +<dd><code>v</code> - the value to search for.</dd> +<dd><code>crit</code> - one of LT, LE, EQ, GT, GE</dd> +<dt>Returns:</dt> +<dd>the index of the value in the given search range that satisfies the criterion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="find(long[],int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)"> +<h3>find</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">find</span><wbr><span class="parameters">(long[] arr, + int low, + int high, + double v, + <a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</span></div> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion. + If -1 is returned there are no values in the search range that satisfy the criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - the given array that must be sorted.</dd> +<dd><code>low</code> - the lowest index of the lowest value in the search range, inclusive.</dd> +<dd><code>high</code> - the highest index of the highest value in the search range, inclusive.</dd> +<dd><code>v</code> - the value to search for.</dd> +<dd><code>crit</code> - one of LT, LE, EQ, GT, GE</dd> +<dt>Returns:</dt> +<dd>the index of the value in the given search range that satisfies the criterion</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html new file mode 100644 index 000000000..2cc28fff5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html @@ -0,0 +1,556 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ItemsSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: ItemsSketchSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ItemsSketchSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class ItemsSketchSortedView" class="title">Class ItemsSketchSortedView<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.ItemsSketchSortedView<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The sketch data type</dd> +</dl> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></code>, <code><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T></code>, <code><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code>, <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ItemsSketchSortedView<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></span></div> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(T%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesGenericAPI)" class="member-name-link">ItemsSketchSortedView</a><wbr>(<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[] quantiles, + long[] cumWeights, + <a href="QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComparator()" class="member-name-link">getComparator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Comparator for this generic type.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCumulativeWeights()" class="member-name-link">getCumulativeWeights</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the array of cumulative weights from the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxPartitions()" class="member-name-link">getMaxPartitions</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the maximum number of partitions this sketch will support based on the configured size <i>K</i> + and the number of retained values of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by this sorted view.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartitionSize, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the full array of quantiles.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles corresponding to the given array of ranks.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a> quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sorted view is empty.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.GenericSortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></h3> +<code><a href="GenericSortedView.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a>, <a href="GenericSortedView.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.PartitioningFeature">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></h3> +<code><a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)">getPartitionBoundariesFromNumParts</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)">getPartitionBoundariesFromPartSize</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SketchPartitionLimits">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></h3> +<code><a href="SketchPartitionLimits.html#getMinPartitionSizeItems()">getMinPartitionSizeItems</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(T[],long[],org.apache.datasketches.quantilescommon.QuantilesGenericAPI)"> +<h3 id="<init>(java.lang.Object[],long[],org.apache.datasketches.quantilescommon.QuantilesGenericAPI)">ItemsSketchSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ItemsSketchSortedView</span><wbr><span class="parameters">(<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[] quantiles, + long[] cumWeights, + <a href="QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>> sk)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles, which must be ordered.</dd> +<dd><code>cumWeights</code> - the given array of cumulative weights, which must be ordered, start with the value one, and + the last value must be equal to N, the total number of items updated to the sketch.</dd> +<dd><code>sk</code> - the underlying quantile sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getComparator()"> +<h3>getComparator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></span> <span class="element-name">getComparator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="GenericSortedView.html#getComparator()">GenericSortedView</a></code></span></div> +<div class="block">Gets the Comparator for this generic type.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="GenericSortedView.html#getComparator()">getComparator</a></code> in interface <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the Comparator for this generic type.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCumulativeWeights()"> +<h3>getCumulativeWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getCumulativeWeights</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getCumulativeWeights()">SortedView</a></code></span></div> +<div class="block">Returns the array of cumulative weights from the sketch. + Also known as the natural ranks, which are the Natural Numbers on the interval [1, N].</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the array of cumulative weights (or natural ranks).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a></span> <span class="element-name">getMaxItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="GenericSortedView.html#getMaxItem()">GenericSortedView</a></code></span></div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="GenericSortedView.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a></span> <span class="element-name">getMinItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="GenericSortedView.html#getMinItem()">GenericSortedView</a></code></span></div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="GenericSortedView.html#getMinItem()">getMinItem</a></code> in interface <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SketchPartitionLimits.html#getN()">SketchPartitionLimits</a></code></span></div> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SketchPartitionLimits.html#getN()">getN</a></code> in interface <code><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getN()">getN</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the length of the input stream offered to the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getNumRetained()">SortedView</a></code></span></div> +<div class="block">Gets the number of quantiles retained by this sorted view. + This may be slightly different from the function with the same name when called from the originating sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by this sorted view</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxPartitions()"> +<h3>getMaxPartitions</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxPartitions</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SketchPartitionLimits.html#getMaxPartitions()">SketchPartitionLimits</a></code></span></div> +<div class="block">Gets the maximum number of partitions this sketch will support based on the configured size <i>K</i> + and the number of retained values of this sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SketchPartitionLimits.html#getMaxPartitions()">getMaxPartitions</a></code> in interface <code><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum number of partitions this sketch will support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromPartSize</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></span> <span class="element-name">getPartitionBoundariesFromPartSize</span><wbr><span class="parameters">(long nominalPartitionSize, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">PartitioningFeature</a></code></span></div> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromPartSize</a></code> in interface <code><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>nominalPartitionSize</code> - an integer that specifies the nominal size, in items, of each target partition. + This must be a positive integer greater than + <a href="SketchPartitionLimits.html#getMinPartitionSizeItems()"><code>getMinPartitionSizeItems()</code></a>.</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromNumParts</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></span> <span class="element-name">getPartitionBoundariesFromNumParts</span><wbr><span class="parameters">(int numEquallySizedParts, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">PartitioningFeature</a></code></span></div> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromNumParts</a></code> in interface <code><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>numEquallySizedParts</code> - an integer that specifies the number of equally sized partitions between + <a href="GenericPartitionBoundaries.html#getMinItem()"><code>getMinItem()</code></a> and + <a href="GenericPartitionBoundaries.html#getMaxItem()"><code>getMaxItem()</code></a>. + This must be a positive integer less than + <a href="SketchPartitionLimits.html#getMaxPartitions()"><code>getMaxPartitions()</code></a> + <ul> + <li>A 1 will return: minItem, maxItem.</li> + <li>A 2 will return: minItem, median quantile, maxItem.</li> + <li>Etc.</li> + </ul></dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a></span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="GenericSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">GenericSortedView</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="GenericSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of quantiles corresponding to the given array of ranks.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks</dd> +<dd><code>searchCrit</code> - The search criterion: either INCLUSIVE or EXCLUSIVE.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of ranks.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="GenericSortedView.html#getQuantiles()">GenericSortedView</a></code></span></div> +<div class="block">Returns the full array of quantiles.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="GenericSortedView.html#getQuantiles()">getQuantiles</a></code> in interface <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Returns:</dt> +<dd>the full array of quantiles.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRank(java.lang.Object,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a> quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="GenericSortedView.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">GenericSortedView</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="GenericSortedView.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#isEmpty()">SortedView</a></code></span></div> +<div class="block">Returns true if this sorted view is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#isEmpty()">isEmpty</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sorted view is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="GenericSortedView.html#iterator()">iterator</a></code> in interface <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html new file mode 100644 index 000000000..c22347ca3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html @@ -0,0 +1,254 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>KolmogorovSmirnov (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: KolmogorovSmirnov"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/KolmogorovSmirnov.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class KolmogorovSmirnov" class="title">Class KolmogorovSmirnov</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.KolmogorovSmirnov</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">KolmogorovSmirnov</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Kolmogorov-Smirnov Test + See <a href="https://en.wikipedia.org/wiki/Kolmogorov-Smirnov_test">Kolmogorov–Smirnov Test</a></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">KolmogorovSmirnov</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesDoublesAPI,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)" class="member-name-link">computeKSDelta</a><wbr>(<a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sketch1, + <a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sketch2)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the raw delta between two QuantilesDoublesAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesFloatsAPI,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)" class="member-name-link">computeKSDelta</a><wbr>(<a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sketch1, + <a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sketch2)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the raw delta between two QuantilesFloatsAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeKSThreshold(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)" class="member-name-link">computeKSThreshold</a><wbr>(<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch1, + <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch2, + double tgtPvalue)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the adjusted delta height threshold for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#kolmogorovSmirnovTest(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)" class="member-name-link">kolmogorovSmirnovTest</a><wbr>(<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch1, + <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch2, + double tgtPvalue)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Performs the Kolmogorov-Smirnov Test between two QuantilesAPI sketches.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>KolmogorovSmirnov</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">KolmogorovSmirnov</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesDoublesAPI,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)"> +<h3>computeKSDelta</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">computeKSDelta</span><wbr><span class="parameters">(<a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sketch1, + <a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sketch2)</span></div> +<div class="block">Computes the raw delta between two QuantilesDoublesAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch1</code> - first Input QuantilesDoublesAPI</dd> +<dd><code>sketch2</code> - second Input QuantilesDoublesAPI</dd> +<dt>Returns:</dt> +<dd>the raw delta area between two QuantilesDoublesAPI sketches</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesFloatsAPI,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)"> +<h3>computeKSDelta</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">computeKSDelta</span><wbr><span class="parameters">(<a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sketch1, + <a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sketch2)</span></div> +<div class="block">Computes the raw delta between two QuantilesFloatsAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method. + method.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch1</code> - first Input QuantilesFloatsAPI sketch</dd> +<dd><code>sketch2</code> - second Input QuantilesFloatsAPI sketch</dd> +<dt>Returns:</dt> +<dd>the raw delta area between two QuantilesFloatsAPI sketches</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="computeKSThreshold(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)"> +<h3>computeKSThreshold</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">computeKSThreshold</span><wbr><span class="parameters">(<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch1, + <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch2, + double tgtPvalue)</span></div> +<div class="block">Computes the adjusted delta height threshold for the <i>kolmogorovSmirnovTest(...)</i> method. + This adjusts the computed threshold by the error epsilons of the two given sketches. + The two sketches must be of the same primitive type, double or float. + This will not work with the REQ sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch1</code> - first Input QuantilesAPI sketch</dd> +<dd><code>sketch2</code> - second Input QuantilesAPI sketch</dd> +<dd><code>tgtPvalue</code> - Target p-value. Typically .001 to .1, e.g., .05.</dd> +<dt>Returns:</dt> +<dd>the adjusted threshold to be compared with the raw delta area.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="kolmogorovSmirnovTest(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)"> +<h3>kolmogorovSmirnovTest</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">kolmogorovSmirnovTest</span><wbr><span class="parameters">(<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch1, + <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch2, + double tgtPvalue)</span></div> +<div class="block">Performs the Kolmogorov-Smirnov Test between two QuantilesAPI sketches. + Note: if the given sketches have insufficient data or if the sketch sizes are too small, + this will return false. The two sketches must be of the same primitive type, double or float. + This will not work with the REQ sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch1</code> - first Input QuantilesAPI</dd> +<dd><code>sketch2</code> - second Input QuantilesAPI</dd> +<dd><code>tgtPvalue</code> - Target p-value. Typically .001 to .1, e.g., .05.</dd> +<dt>Returns:</dt> +<dd>Boolean indicating whether we can reject the null hypothesis (that the sketches + reflect the same underlying distribution) using the provided tgtPValue.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSketchSortedView.html new file mode 100644 index 000000000..8e8c8de2b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSketchSortedView.html @@ -0,0 +1,401 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>LongsSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: LongsSketchSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/LongsSketchSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class LongsSketchSortedView" class="title">Class LongsSketchSortedView</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.LongsSketchSortedView</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code>, <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">LongsSketchSortedView</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></span></div> +<div class="block">The SortedView of the KllLongsSketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Zac Blanco</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(long%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesLongsAPI)" class="member-name-link">LongsSketchSortedView</a><wbr>(long[] quantiles, + long[] cumWeights, + <a href="QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct from elements, also used in testing.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCumulativeWeights()" class="member-name-link">getCumulativeWeights</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the array of cumulative weights from the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by this sorted view.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sorted view is empty.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.LongsSortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></h3> +<code><a href="LongsSortedView.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a>, <a href="LongsSortedView.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(long[],long[],org.apache.datasketches.quantilescommon.QuantilesLongsAPI)"> +<h3>LongsSketchSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LongsSketchSortedView</span><wbr><span class="parameters">(long[] quantiles, + long[] cumWeights, + <a href="QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a> sk)</span></div> +<div class="block">Construct from elements, also used in testing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - sorted array of quantiles</dd> +<dd><code>cumWeights</code> - sorted, monotonically increasing cumulative weights.</dd> +<dd><code>sk</code> - the underlying quantile sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCumulativeWeights()"> +<h3>getCumulativeWeights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getCumulativeWeights</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getCumulativeWeights()">SortedView</a></code></span></div> +<div class="block">Returns the array of cumulative weights from the sketch. + Also known as the natural ranks, which are the Natural Numbers on the interval [1, N].</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the array of cumulative weights (or natural ranks).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="LongsSortedView.html#getMaxItem()">LongsSortedView</a></code></span></div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="LongsSortedView.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMinItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="LongsSortedView.html#getMinItem()">LongsSortedView</a></code></span></div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="LongsSortedView.html#getMinItem()">getMinItem</a></code> in interface <code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getN()">SortedView</a></code></span></div> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getN()">getN</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the total number of items presented to the sourcing sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#getNumRetained()">SortedView</a></code></span></div> +<div class="block">Gets the number of quantiles retained by this sorted view. + This may be slightly different from the function with the same name when called from the originating sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by this sorted view</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="LongsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">LongsSortedView</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="LongsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="LongsSortedView.html#getQuantiles()">LongsSortedView</a></code></span></div> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="LongsSortedView.html#getQuantiles()">getQuantiles</a></code> in interface <code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an array of all retained quantiles by the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(long quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="LongsSortedView.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">LongsSortedView</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="LongsSortedView.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#isEmpty()">SortedView</a></code></span></div> +<div class="block">Returns true if this sorted view is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#isEmpty()">isEmpty</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sorted view is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="LongsSortedView.html#iterator()">iterator</a></code> in interface <code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></dd> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSortedView.html new file mode 100644 index 000000000..eb2d554aa --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSortedView.html @@ -0,0 +1,384 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>LongsSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: LongsSortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/LongsSortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface LongsSortedView" class="title">Interface LongsSortedView</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">LongsSortedView</span><span class="extends-implements"> +extends <a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></span></div> +<div class="block">The Sorted View for quantile sketches of primitive type long.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Zac Blanco</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon"><code>SortedView</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles()" class="member-name-link">getQuantiles</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedView">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></h3> +<code><a href="SortedView.html#getCumulativeWeights()">getCumulativeWeights</a>, <a href="SortedView.html#getN()">getN</a>, <a href="SortedView.html#getNumRetained()">getNumRetained</a>, <a href="SortedView.html#isEmpty()">isEmpty</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles()"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type">long[]</span> <span class="element-name">getQuantiles</span>()</div> +<div class="block">Returns an array of all retained quantiles by the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array of all retained quantiles by the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(long quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SortedView.html#iterator()">SortedView</a></code></span></div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SortedView.html#iterator()">iterator</a></code> in interface <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html new file mode 100644 index 000000000..5a3afe6f8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>LongsSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: LongsSortedViewIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/LongsSortedViewIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class LongsSortedViewIterator" class="title">Class LongsSortedViewIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon.SortedViewIterator</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.LongsSortedViewIterator</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">LongsSortedViewIterator</span> +<span class="extends-implements">extends <a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></span></div> +<div class="block">Iterator over quantile sketches of primitive type <i>long</i>.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(long%5B%5D,long%5B%5D)" class="member-name-link">LongsSortedViewIterator</a><wbr>(long[] quantiles, + long[] cumWeights)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SortedViewIterator">Methods inherited from class org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></h3> +<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank()">getNaturalRank</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank()">getNormalizedRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(long[],long[])"> +<h3>LongsSortedViewIterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LongsSortedViewIterator</span><wbr><span class="parameters">(long[] quantiles, + long[] cumWeights)</span></div> +<div class="block">Constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles, which must be ordered.</dd> +<dd><code>cumWeights</code> - the given array of cumulative weights, which must be ordered, start with the value one, and + the last value must be equal to N, the total number of items updated to the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/PartitioningFeature.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/PartitioningFeature.html new file mode 100644 index 000000000..1c15ea716 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/PartitioningFeature.html @@ -0,0 +1,279 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>PartitioningFeature (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: PartitioningFeature"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/PartitioningFeature.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface PartitioningFeature" class="title">Interface PartitioningFeature<T></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +</dl> +<dl class="notes"> +<dt>All Known Subinterfaces:</dt> +<dd><code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></code>, <code><a href="QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></code>, <code><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></code>, <code><a href="../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">PartitioningFeature<T></span></div> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPartitionBoundariesFromNumParts(int)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPartitionBoundariesFromPartSize(long)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getPartitionBoundariesFromNumParts(int)"> +<h3>getPartitionBoundariesFromNumParts</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></span> <span class="element-name">getPartitionBoundariesFromNumParts</span><wbr><span class="parameters">(int numEquallySizedParts)</span></div> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>This method is equivalent to + <a href="#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPartitionBoundariesFromNumParts(numEquallySizedParts, INCLUSIVE)</code></a>. + </p> + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numEquallySizedParts</code> - an integer that specifies the number of equally sized partitions between + <a href="GenericPartitionBoundaries.html#getMinItem()"><code>getMinItem()</code></a> and + <a href="GenericPartitionBoundaries.html#getMaxItem()"><code>getMaxItem()</code></a>. + This must be a positive integer less than + <a href="SketchPartitionLimits.html#getMaxPartitions()"><code>getMaxPartitions()</code></a> + <ul> + <li>A 1 will return: minItem, maxItem.</li> + <li>A 2 will return: minItem, median quantile, maxItem.</li> + <li>Etc.</li> + </ul></dd> +<dt>Returns:</dt> +<dd>an instance of <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromNumParts</h3> +<div class="member-signature"><span class="return-type"><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></span> <span class="element-name">getPartitionBoundariesFromNumParts</span><wbr><span class="parameters">(int numEquallySizedParts, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numEquallySizedParts</code> - an integer that specifies the number of equally sized partitions between + <a href="GenericPartitionBoundaries.html#getMinItem()"><code>getMinItem()</code></a> and + <a href="GenericPartitionBoundaries.html#getMaxItem()"><code>getMaxItem()</code></a>. + This must be a positive integer less than + <a href="SketchPartitionLimits.html#getMaxPartitions()"><code>getMaxPartitions()</code></a> + <ul> + <li>A 1 will return: minItem, maxItem.</li> + <li>A 2 will return: minItem, median quantile, maxItem.</li> + <li>Etc.</li> + </ul></dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromPartSize(long)"> +<h3>getPartitionBoundariesFromPartSize</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></span> <span class="element-name">getPartitionBoundariesFromPartSize</span><wbr><span class="parameters">(long nominalPartSizeItems)</span></div> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>This method is equivalent to + <a href="#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPartitionBoundariesFromPartSize(nominalPartSizeItems, INCLUSIVE)</code></a>. + </p> + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nominalPartSizeItems</code> - an integer that specifies the nominal size, in items, of each target partition. + This must be a positive integer greater than + <a href="SketchPartitionLimits.html#getMinPartitionSizeItems()"><code>getMinPartitionSizeItems()</code></a></dd> +<dt>Returns:</dt> +<dd>an instance of <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPartitionBoundariesFromPartSize</h3> +<div class="member-signature"><span class="return-type"><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></span> <span class="element-name">getPartitionBoundariesFromPartSize</span><wbr><span class="parameters">(long nominalPartSizeItems, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">This method returns an instance of + <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition. + + <p>The sketch must not be empty.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nominalPartSizeItems</code> - an integer that specifies the nominal size, in items, of each target partition. + This must be a positive integer greater than + <a href="SketchPartitionLimits.html#getMinPartitionSizeItems()"><code>getMinPartitionSizeItems()</code></a>.</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally sized partitions + with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition. + If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally sized partitions + with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd> +<dt>Returns:</dt> +<dd>an instance of <a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a>.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html new file mode 100644 index 000000000..162968909 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html @@ -0,0 +1,262 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantileSearchCriteria (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, enum: QuantileSearchCriteria"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantileSearchCriteria.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Enum Class QuantileSearchCriteria" class="title">Enum Class QuantileSearchCriteria</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>> +<div class="inheritance">org.apache.datasketches.quantilescommon.QuantileSearchCriteria</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">QuantileSearchCriteria</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>></span></div> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="https://datasketches.apache.org/docs/QuantilesAll/SketchingQuantilesAndRanksTutorial.html"> + Sketching Quantiles and Ranks Tutorial</a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#EXCLUSIVE" class="member-name-link">EXCLUSIVE</a></code></div> +<div class="col-last even-row-color"> +<div class="block"><b>Definition of EXCLUSIVE <i>getQuantile(r)</i> search:</b><br> + Given rank <i>r</i>, return the quantile of the smallest rank that is + strictly greater than <i>r</i>.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#INCLUSIVE" class="member-name-link">INCLUSIVE</a></code></div> +<div class="col-last odd-row-color"> +<div class="block"><b>Definition of INCLUSIVE <i>getQuantile(r)</i> search:</b><br> + Given rank <i>r</i>, return the quantile of the smallest rank that is + strictly greater than or equal to <i>r</i>.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="INCLUSIVE"> +<h3>INCLUSIVE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span> <span class="element-name">INCLUSIVE</span></div> +<div class="block"><b>Definition of INCLUSIVE <i>getQuantile(r)</i> search:</b><br> + Given rank <i>r</i>, return the quantile of the smallest rank that is + strictly greater than or equal to <i>r</i>. + + <p><b>Definition of INCLUSIVE <i>getRank(q)</i> search:</b><br> + Given quantile <i>q</i>, return the rank, <i>r</i>, of the largest quantile that is + less than or equal to <i>q</i>.</p></div> +</section> +</li> +<li> +<section class="detail" id="EXCLUSIVE"> +<h3>EXCLUSIVE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span> <span class="element-name">EXCLUSIVE</span></div> +<div class="block"><b>Definition of EXCLUSIVE <i>getQuantile(r)</i> search:</b><br> + Given rank <i>r</i>, return the quantile of the smallest rank that is + strictly greater than <i>r</i>. + + <p>However, if the given rank is is equal to 1.0, or there is no quantile that satisfies this criterion + the method will return a <i>NaN</i> or <i>null</i>.</p> + + <p><b>Definition of EXCLUSIVE <i>getRank(q)</i> search:</b><br> + Given quantile <i>q</i>, return the rank, <i>r</i>, of the largest quantile that is + strictly less than <i>q</i>.</p> + + <p>If there is no quantile value that is strictly less than <i>q</i>, + the method will return a rank of zero.</p></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesAPI.html new file mode 100644 index 000000000..8c6785dc1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesAPI.html @@ -0,0 +1,681 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesAPI"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesAPI.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesAPI" class="title">Interface QuantilesAPI</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Subinterfaces:</dt> +<dd><code><a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code>, <code><a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code>, <code><a href="QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code>, <code><a href="QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code>, <code><a href="../quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code>, <code><a href="../quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></code>, <code><a href="../kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code>, <code><a href="../kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code>, <code><a href="../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></code>, <code><a href="../kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code>, <code><a href="../kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></code>, <code><a href="../req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code>, <code><a href="../quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesAPI</span></div> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable. + The analysis is obtained using the <i>getQuantile()</i> function or the + inverse functions getRank(), getPMF() (the Probability Mass Function), and getCDF() + (the Cumulative Distribution Function). + + <p>Given an input stream of <i>N</i> items, the <i>natural rank</i> of any specific + item is defined as its index <i>(1 to N)</i> in the hypothetical sorted stream of all + <i>N</i> input items.</p> + + <p>The <i>normalized rank</i> (<i>rank</i>) of any specific item is defined as its + <i>natural rank</i> divided by <i>N</i>, which is a number in the interval [0.0, 1.0]. + In the Javadocs for all the quantile sketches <i>natural rank</i> is seldom used + so any reference to just <i>rank</i> should be interpreted as <i>normalized rank</i>.</p> + + <p>Inputs into a quantile sketch are called "items" that can be either generic or specific + primitives, like <i>float</i> or <i>double</i> depending on the sketch implementation. + In order to keep its size small, sketches don't retain all the items offered and retain only + a small fraction of all the items, thus purging most of the items. The items retained are + then sorted and associated with a rank. At this point we call the retained items <i>quantiles</i>. + Thus, all quantiles are items, but only a few items become quantiles. Depending on the context + the two terms can be interchangeable.</p> + + <p>All quantile sketches are configured with a parameter <i>k</i>, which affects the size of + the sketch and its estimation error.</p> + + <p>In the research literature, the estimation error is commonly called <i>epsilon</i> + (or <i>eps</i>) and is a fraction between zero and one. + Larger sizes of <i>k</i> result in a smaller epsilon, but also a larger sketch. + The epsilon error is always with respect to the rank domain. Estimating the confidence interval + in the quantile domain can be done by first computing the error in the rank domain and then + translating that to the quantile domain. The sketch provides methods to assist with that.</p> + + <p>The relationship between the normalized rank and the corresponding quantiles can be viewed + as a two dimensional monotonic plot with the normalized rank on one axis and the + corresponding quantiles on the other axis. Let <i>q := quantile</i> and <i>r := rank</i> then both + <i>q = getQuantile(r)</i> and <i>r = getRank(q)</i> are monotonically increasing functions. + If the y-axis is used for the rank domain and the x-axis for the quantile domain, + then <i>y = getRank(x)</i> is also the single point Cumulative Distribution Function (CDF).</p> + + <p>The functions <i>getQuantile()</i> translate ranks into corresponding quantiles. + The functions <i>getRank(), getCDF(), and getPMF() (Probability Mass Function)</i> + perform the opposite operation and translate quantiles into ranks (or cumulative probabilities, + or probability masses, depending on the context).</p> + + <p>As an example, consider a large stream of one million items such as packet sizes coming into a network node. + The absolute rank of any specific item size is simply its index in the hypothetical sorted + array of such items. + The normalized rank is the natural rank divided by the stream size, or <i>N</i>, + in this case one million. + The quantile corresponding to the normalized rank of 0.5 represents the 50th percentile or median + of the distribution, obtained from getQuantile(0.5). Similarly, the 95th percentile is obtained from + getQuantile(0.95).</p> + + <p>From the min and max quantiles, for example, say 1 and 1000 bytes, + you can obtain the PMF from getPMF(100, 500, 900) that will result in an array of + 4 probability masses such as {.4, .3, .2, .1}, which means that + <ul> + <li>40% of the mass was < 100,</li> + <li>30% of the mass was ≥ 100 and < 500,</li> + <li>20% of the mass was ≥ 500 and < 900, and</li> + <li>10% of the mass was ≥ 900.</li> + </ul> + A frequency histogram can be obtained by simply multiplying these probability masses by getN(), + which is the total count of items received. + The <i>getCDF()</i> works similarly, but produces the cumulative distribution instead. + + <p>The accuracy of this sketch is a function of the configured <i>k</i>, which also affects + the overall size of the sketch. Accuracy of this quantile sketch is always with respect to + the normalized rank. + + <p>The <i>getPMF()</i> function has about 13 to 47% worse rank error (depending + on <i>k</i>) than the other queries because the mass of each "bin" of the PMF has + "double-sided" error from the upper and lower edges of the bin as a result of a subtraction + of random variables where the errors from the two edges can sometimes add.</p> + + <p>A <i>getQuantile(rank)</i> query has the following probabilistic guarantees:</p> + <ul> + <li>Let <i>q = getQuantile(r)</i> where <i>r</i> is the rank between zero and one.</li> + <li>The quantile <i>q</i> will be a quantile from the input stream.</li> + <li>Let <i>trueRank</i> be the true rank of <i>q</i> derived from the hypothetical sorted + stream of all <i>N</i> quantiles.</li> + <li>Let <i>eps = getNormalizedRankError(false)</i>[*].</li> + <li>Then <i>r - eps ≤ trueRank ≤ r + eps</i>. + Note that the error is on the rank, not the quantile.</li> + </ul> + + <p>A <i>getRank(quantile)</i> query has the following probabilistic guarantees:</p> + <ul> + <li>Let <i>r = getRank(q)</i> where <i>q</i> is a quantile between the min and max quantiles of + the input stream.</li> + <li>Let <i>trueRank</i> be the true rank of <i>q</i> derived from the hypothetical sorted + stream of all <i>N</i> quantiles.</li> + <li>Let <i>eps = getNormalizedRankError(false)</i>[*].</li> + <li>Then <i>r - eps ≤ trueRank ≤ r + eps</i>.</li> + </ul> + + <p>A <i>getPMF()</i> query has the following probabilistic guarantees:</p> + <ul> + <li>Let <i>{r<sub>1</sub>, r<sub>2</sub>, ..., r<sub>m+1</sub>} + = getPMF(v<sub>1</sub>, v<sub>2</sub>, ..., v<sub>m</sub>)</i> where + <i>q<sub>1</sub>, q<sub>2</sub>, ..., q<sub>m</sub></i> are monotonically increasing quantiles + supplied by the user that are part of the monotonic sequence + <i>q<sub>0</sub> = min, q<sub>1</sub>, q<sub>2</sub>, ..., q<sub>m</sub>, q<sub>m+1</sub> = max</i>, + and where <i>min</i> and <i>max</i> are the actual minimum and maximum quantiles of the input + stream automatically included in the sequence by the <i>getPMF(...)</i> function. + + <li>Let <i>r<sub>i</sub> = mass<sub>i</sub></i> = estimated mass between + <i>v<sub>i-1</sub></i> and <i>q<sub>i</sub></i> where <i>q<sub>0</sub> = min</i> + and <i>q<sub>m+1</sub> = max</i>.</li> + + <li>Let <i>trueMass</i> be the true mass between the quantiles of <i>q<sub>i</sub>, + q<sub>i+1</sub></i> derived from the hypothetical sorted stream of all <i>N</i> quantiles.</li> + <li>Let <i>eps = getNormalizedRankError(true)</i>[*].</li> + <li>Then <i>mass - eps ≤ trueMass ≤ mass + eps</i>.</li> + <li><i>r<sub>1</sub></i> includes the mass of all points between <i>min = q<sub>0</sub></i> and + <i>q<sub>1</sub></i>.</li> + <li><i>r<sub>m+1</sub></i> includes the mass of all points between <i>q<sub>m</sub></i> and + <i>max = q<sub>m+1</sub></i>.</li> + </ul> + + <p>A <i>getCDF(...)</i> query has the following probabilistic guarantees:</p> + <ul> + <li>Let <i>{r<sub>1</sub>, r<sub>2</sub>, ..., r<sub>m+1</sub>} + = getCDF(q<sub>1</sub>, q<sub>2</sub>, ..., q<sub>m</sub>)</i> where + <i>q<sub>1</sub>, q<sub>2</sub>, ..., q<sub>m</sub>)</i> are monotonically increasing quantiles + supplied by the user that are part of the monotonic sequence + <i>{q<sub>0</sub> = min, q<sub>1</sub>, q<sub>2</sub>, ..., q<sub>m</sub>, q<sub>m+1</sub> = max}</i>, + and where <i>min</i> and <i>max</i> are the actual minimum and maximum quantiles of the input + stream automatically included in the sequence by the <i>getCDF(...)</i> function. + + <li>Let <i>r<sub>i</sub> = mass<sub>i</sub></i> = estimated mass between + <i>q<sub>0</sub> = min</i> and <i>q<sub>i</sub></i>.</li> + + <li>Let <i>trueMass</i> be the true mass between the true ranks of <i>q<sub>i</sub>, + q<sub>i+1</sub></i> derived from the hypothetical sorted stream of all <i>N</i> quantiles.</li> + <li>Let <i>eps = getNormalizedRankError(true)</i>[*].</li> + <li>then <i>mass - eps ≤ trueMass ≤ mass + eps</i>.</li> + <li><i>r<sub>1</sub></i> includes the mass of all points between <i>min = q<sub>0</sub></i> and + <i>q<sub>1</sub></i>.</li> + <li><i>r<sub>m+1</sub></i> includes the mass of all points between <i>min = q<sub>0</sub></i> and + <i>max = q<sub>m+1</sub></i>.</li> + </ul> + + <p>Because errors are independent, we can make some estimates of the size of the confidence bounds + for the <em>quantile</em> returned from a call to <em>getQuantile()</em>, but not error bounds. + These confidence bounds may be quite large for certain distributions.</p> + + <ul> + <li>Let <i>q = getQuantile(r)</i>, the estimated quantile of rank <i>r</i>.</li> + <li>Let <i>eps = getNormalizedRankError(false)</i>[*].</li> + <li>Let <i>q<sub>lo</sub></i> = estimated quantile of rank <i>(r - eps)</i>.</li> + <li>Let <i>q<sub>hi</sub></i> = estimated quantile of rank <i>(r + eps)</i>.</li> + <li>Then <i>q<sub>lo</sub> ≤ q ≤ q<sub>hi</sub></i>.</li> + </ul> + + <p>This sketch is order and distribution insensitive</p> + + <p>This algorithm intentionally inserts randomness into the sampling process for items that + ultimately get retained in the sketch. Thus, the results produced by this algorithm are not + deterministic. For example, if the same stream is inserted into two different instances of this + sketch, the answers obtained from the two sketches should be close, but may not be be identical.</p> + + <p>Similarly, there may be directional inconsistencies. For example, if a quantile obtained + from getQuantile(rank) is input into the reverse query + getRank(quantile), the resulting rank should be close, but may not exactly equal the original rank.</p> + + <p>Please visit our website: <a href="https://datasketches.apache.org">DataSketches Home Page</a> + and specific Javadocs for more information.</p> + + <p>[*] Note that obtaining epsilon may require using a similar function but with more parameters + based on the specific sketch implementation.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang, Alexander Saydakov</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="https://datasketches.apache.org/docs/QuantilesAll/SketchingQuantilesAndRanksTutorial.html"> + Sketching Quantiles and Ranks, Tutorial</a></li> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#EMPTY_MSG" class="member-name-link">EMPTY_MSG</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The sketch must not be empty for this operation.</div> +</div> +<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#MEM_REQ_SVR_NULL_MSG" class="member-name-link">MEM_REQ_SVR_NULL_MSG</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">MemoryRequestServer must not be null.</div> +</div> +<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#NOT_SINGLE_ITEM_MSG" class="member-name-link">NOT_SINGLE_ITEM_MSG</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Sketch does not have just one item.</div> +</div> +<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#SELF_MERGE_MSG" class="member-name-link">SELF_MERGE_MSG</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A sketch cannot merge with itself.</div> +</div> +<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#TGT_IS_READ_ONLY_MSG" class="member-name-link">TGT_IS_READ_ONLY_MSG</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Target sketch is Read Only, cannot write.</div> +</div> +<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#UNSUPPORTED_MSG" class="member-name-link">UNSUPPORTED_MSG</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Unsupported operation for this Sketch Type.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(boolean pmf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch is empty.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch is in estimation mode.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch is read only.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a summary of the key parameters of the sketch.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="EMPTY_MSG"> +<h3>EMPTY_MSG</h3> +<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">EMPTY_MSG</span></div> +<div class="block">The sketch must not be empty for this operation.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.quantilescommon.QuantilesAPI.EMPTY_MSG">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="UNSUPPORTED_MSG"> +<h3>UNSUPPORTED_MSG</h3> +<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">UNSUPPORTED_MSG</span></div> +<div class="block">Unsupported operation for this Sketch Type.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.quantilescommon.QuantilesAPI.UNSUPPORTED_MSG">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="NOT_SINGLE_ITEM_MSG"> +<h3>NOT_SINGLE_ITEM_MSG</h3> +<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">NOT_SINGLE_ITEM_MSG</span></div> +<div class="block">Sketch does not have just one item.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.quantilescommon.QuantilesAPI.NOT_SINGLE_ITEM_MSG">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="MEM_REQ_SVR_NULL_MSG"> +<h3>MEM_REQ_SVR_NULL_MSG</h3> +<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">MEM_REQ_SVR_NULL_MSG</span></div> +<div class="block">MemoryRequestServer must not be null.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.quantilescommon.QuantilesAPI.MEM_REQ_SVR_NULL_MSG">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="TGT_IS_READ_ONLY_MSG"> +<h3>TGT_IS_READ_ONLY_MSG</h3> +<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">TGT_IS_READ_ONLY_MSG</span></div> +<div class="block">Target sketch is Read Only, cannot write.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.quantilescommon.QuantilesAPI.TGT_IS_READ_ONLY_MSG">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="SELF_MERGE_MSG"> +<h3>SELF_MERGE_MSG</h3> +<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">SELF_MERGE_MSG</span></div> +<div class="block">A sketch cannot merge with itself.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.quantilescommon.QuantilesAPI.SELF_MERGE_MSG">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the length of the input stream offered to the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(boolean pmf)</span></div> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one. + The epsilon returned is a best fit to 99 percent confidence empirically measured max error + in thousands of trials.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of quantiles retained by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if this sketch is empty.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block">Returns true if this sketch is in estimation mode.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +<div class="block">Returns true if this sketch is read only.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is read only.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p></div> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a summary of the key parameters of the sketch.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>a summary of the key parameters of the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html new file mode 100644 index 000000000..243039f6b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html @@ -0,0 +1,677 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesDoublesAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesDoublesAPI"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesDoublesAPI.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesDoublesAPI" class="title">Interface QuantilesDoublesAPI</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code>, <code><a href="../quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code>, <code><a href="../kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code>, <code><a href="../quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesDoublesAPI</span><span class="extends-implements"> +extends <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(double%5B%5D)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(double%5B%5D)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantile(double)" class="member-name-link">getQuantile</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRank(double)" class="member-name-link">getRank</a><wbr>(double quantile)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRanks(double%5B%5D)" class="member-name-link">getRanks</a><wbr>(double[] quantiles)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(double[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Updates this sketch with the given item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#getK()">getK</a>, <a href="QuantilesAPI.html#getN()">getN</a>, <a href="QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a>, <a href="QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a>, <a href="QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="QuantilesAPI.html#isDirect()">isDirect</a>, <a href="QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="QuantilesAPI.html#reset()">reset</a>, <a href="QuantilesAPI.html#toString()">toString</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(double[])"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(double[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This is provided for convenience and may be different from the + item returned by <i>getQuantile(1.0)</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This is provided for convenience and may be different from the + item returned by <i>getQuantile(0.0)</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(double[])"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(double[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(double[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[])"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks)</span></div> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(double)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(double quantile)</span></div> +<div class="block">This is equivalent to <a href="#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(double quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(double[])"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(double[] quantiles)</span></div> +<div class="block">This is equivalent to <a href="#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(double[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes()"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span>()</div> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of bytes this sketch would require if serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="return-type"><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double item)</span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of items. NaNs are ignored.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html new file mode 100644 index 000000000..c79835b82 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html @@ -0,0 +1,162 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesDoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesDoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesDoublesSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesDoublesSketchIterator" class="title">Interface QuantilesDoublesSketchIterator</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></code>, <code><a href="../kll/KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesDoublesSketchIterator</span><span class="extends-implements"> +extends <a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesSketchIterator</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the double quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the double quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the double quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html new file mode 100644 index 000000000..514b7fe6b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html @@ -0,0 +1,677 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesFloatsAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesFloatsAPI"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesFloatsAPI.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesFloatsAPI" class="title">Interface QuantilesFloatsAPI</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code>, <code><a href="../req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesFloatsAPI</span><span class="extends-implements"> +extends <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(float%5B%5D)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(float%5B%5D)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantile(double)" class="member-name-link">getQuantile</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default float[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRank(float)" class="member-name-link">getRank</a><wbr>(float quantile)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRanks(float%5B%5D)" class="member-name-link">getRanks</a><wbr>(float[] quantiles)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(float[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(float)" class="member-name-link">update</a><wbr>(float item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Updates this sketch with the given item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#getK()">getK</a>, <a href="QuantilesAPI.html#getN()">getN</a>, <a href="QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a>, <a href="QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a>, <a href="QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="QuantilesAPI.html#isDirect()">isDirect</a>, <a href="QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="QuantilesAPI.html#reset()">reset</a>, <a href="QuantilesAPI.html#toString()">toString</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(float[])"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(float[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This is provided for convenience, but may be different from the largest + item retained by the sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This is provided for convenience, but is distinct from the smallest + item retained by the sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(float[])"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(float[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">float</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[])"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">float[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks)</span></div> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type">float[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(float)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(float quantile)</span></div> +<div class="block">This is equivalent to <a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(float quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(float[])"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(float[] quantiles)</span></div> +<div class="block">This is equivalent to <a href="#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(float[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes()"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span>()</div> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of bytes this sketch would require if serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="return-type"><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(float)"> +<h3>update</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(float item)</span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of quantiles. NaNs are ignored.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html new file mode 100644 index 000000000..0f845c649 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html @@ -0,0 +1,162 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesFloatsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesFloatsSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesFloatsSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesFloatsSketchIterator" class="title">Interface QuantilesFloatsSketchIterator</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../kll/KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></code>, <code><a href="../req/ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesFloatsSketchIterator</span><span class="extends-implements"> +extends <a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesSketchIterator</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the float quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the float quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the float quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html new file mode 100644 index 000000000..ddf113738 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html @@ -0,0 +1,705 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesGenericAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesGenericAPI"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesGenericAPI.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesGenericAPI" class="title">Interface QuantilesGenericAPI<T></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The given item type</dd> +</dl> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T></code>, <code><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></code>, <code><a href="../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesGenericAPI<T></span><span class="extends-implements"> +extends <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a>, <a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, <a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></span></div> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(T%5B%5D)" class="member-name-link">getCDF</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClassOfT()" class="member-name-link">getClassOfT</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getComparator()" class="member-name-link">getComparator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the Comparator of T</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getMaxPartitions()" class="member-name-link">getMaxPartitions</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Gets the maximum number of partitions this sketch will support based on the configured size <i>K</i> + and the number of retained values of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(T%5B%5D)" class="member-name-link">getPMF</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantile(double)" class="member-name-link">getQuantile</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRank(T)" class="member-name-link">getRank</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> quantile)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(T quantile, INCLUSIVE)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRanks(T%5B%5D)" class="member-name-link">getRanks</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] quantiles)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Updates this sketch with the given item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.PartitioningFeature">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></h3> +<code><a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)">getPartitionBoundariesFromNumParts</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromNumParts</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)">getPartitionBoundariesFromPartSize</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromPartSize</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#getK()">getK</a>, <a href="QuantilesAPI.html#getN()">getN</a>, <a href="QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a>, <a href="QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a>, <a href="QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="QuantilesAPI.html#isDirect()">isDirect</a>, <a href="QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="QuantilesAPI.html#reset()">reset</a>, <a href="QuantilesAPI.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.SketchPartitionLimits">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></h3> +<code><a href="SketchPartitionLimits.html#getMinPartitionSizeItems()">getMinPartitionSizeItems</a>, <a href="SketchPartitionLimits.html#getN()">getN</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(T[])"> +<h3 id="getCDF(java.lang.Object[])">getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getCDF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getClassOfT()"> +<h3>getClassOfT</h3> +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></span> <span class="element-name">getClassOfT</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sketch item class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getComparator()"> +<h3>getComparator</h3> +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super <a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></span> <span class="element-name">getComparator</span>()</div> +<div class="block">Returns the Comparator of T</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Comparator of the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This may be distinct from the largest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxPartitions()"> +<h3>getMaxPartitions</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">getMaxPartitions</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SketchPartitionLimits.html#getMaxPartitions()">SketchPartitionLimits</a></code></span></div> +<div class="block">Gets the maximum number of partitions this sketch will support based on the configured size <i>K</i> + and the number of retained values of this sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SketchPartitionLimits.html#getMaxPartitions()">getMaxPartitions</a></code> in interface <code><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum number of partitions this sketch will support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This may be distinct from the smallest item retained by the + sketch algorithm.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(T[])"> +<h3 id="getPMF(java.lang.Object[])">getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getPMF(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[])"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks)</span></div> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(T)"> +<h3 id="getRank(java.lang.Object)">getRank</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> quantile)</span></div> +<div class="block">This is equivalent to <a href="#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(T quantile, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRank(java.lang.Object,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(T[])"> +<h3 id="getRanks(java.lang.Object[])">getRanks</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] quantiles)</span></div> +<div class="block">This is equivalent to <a href="#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(T[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3 id="getRanks(java.lang.Object[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="return-type"><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></span> <span class="element-name">getSortedView</span>()</div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> item)</span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of items. Nulls are ignored.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html new file mode 100644 index 000000000..02c30eaee --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html @@ -0,0 +1,166 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesGenericSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesGenericSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesGenericSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesGenericSketchIterator" class="title">Interface QuantilesGenericSketchIterator<T></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The generic quantile type</dd> +</dl> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a></code>, <code><a href="../kll/KllItemsSketchIterator.html" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesGenericSketchIterator<T></span><span class="extends-implements"> +extends <a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="block">The quantiles sketch iterator for generic types.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesSketchIterator</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesGenericSketchIterator.html" title="type parameter in QuantilesGenericSketchIterator">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the generic quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesGenericSketchIterator.html" title="type parameter in QuantilesGenericSketchIterator">T</a></span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the generic quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the generic quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html new file mode 100644 index 000000000..55aafae3e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html @@ -0,0 +1,677 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesLongsAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesLongsAPI"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesLongsAPI.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesLongsAPI" class="title">Interface QuantilesLongsAPI</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../kll/KllLongsSketch.html" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesLongsAPI</span><span class="extends-implements"> +extends <a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="block">The Quantiles API for item type <i>long</i>.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Zac Blanco</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCDF(long%5B%5D)" class="member-name-link">getCDF</a><wbr>(long[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPMF(long%5B%5D)" class="member-name-link">getPMF</a><wbr>(long[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantile(double)" class="member-name-link">getQuantile</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getQuantiles(double%5B%5D)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRank(long)" class="member-name-link">getRank</a><wbr>(long quantile)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRanks(long%5B%5D)" class="member-name-link">getRanks</a><wbr>(long[] quantiles)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">This is equivalent to <a href="#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(long[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Updates this sketch with the given item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="QuantilesAPI.html#getK()">getK</a>, <a href="QuantilesAPI.html#getN()">getN</a>, <a href="QuantilesAPI.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a>, <a href="QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a>, <a href="QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="QuantilesAPI.html#isDirect()">isDirect</a>, <a href="QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="QuantilesAPI.html#reset()">reset</a>, <a href="QuantilesAPI.html#toString()">toString</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCDF(long[])"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(long[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block">Returns the maximum item of the stream. This is provided for convenience and may be different from the + item returned by <i>getQuantile(1.0)</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getMinItem</span>()</div> +<div class="block">Returns the minimum item of the stream. This is provided for convenience and may be different from the + item returned by <i>getQuantile(0.0)</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(long[])"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(long[] splitPoints)</span></div> +<div class="block">This is equivalent to <a href="#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(long[] splitPoints, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">This is equivalent to <a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantile(rank, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[])"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks)</span></div> +<div class="block">This is equivalent to <a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="return-type">long[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] ranks, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>ranks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(long)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(long quantile)</span></div> +<div class="block">This is equivalent to <a href="#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(quantile, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(long quantile, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(long[])"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(long[] quantiles)</span></div> +<div class="block">This is equivalent to <a href="#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRanks(quantiles, INCLUSIVE)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(long[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(long[] quantiles, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if sketch is empty.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes()"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span>()</div> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of bytes this sketch would require if serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="return-type"><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of items. NaNs are ignored.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html new file mode 100644 index 000000000..75b88fa97 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html @@ -0,0 +1,162 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesLongsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesLongsSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesLongsSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesLongsSketchIterator" class="title">Interface QuantilesLongsSketchIterator</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../kll/KllLongsSketchIterator.html" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesLongsSketchIterator</span><span class="extends-implements"> +extends <a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="block">The quantiles sketch iterator for primitive type long.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Zac Blanco</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesSketchIterator</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the long quantile at the current index.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesSketchIterator">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></h3> +<code><a href="QuantilesSketchIterator.html#getWeight()">getWeight</a>, <a href="QuantilesSketchIterator.html#next()">next</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getQuantile</span>()</div> +<div class="block">Gets the long quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the long quantile at the current index.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html new file mode 100644 index 000000000..8302dcee6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html @@ -0,0 +1,178 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: QuantilesSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface QuantilesSketchIterator" class="title">Interface QuantilesSketchIterator</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Subinterfaces:</dt> +<dd><code><a href="QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code>, <code><a href="QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code>, <code><a href="QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></code>, <code><a href="QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></code>, <code><a href="../quantiles/ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a></code>, <code><a href="../kll/KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></code>, <code><a href="../kll/KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></code>, <code><a href="../kll/KllItemsSketchIterator.html" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a></code>, <code><a href="../kll/KllLongsSketchIterator.html" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></code>, <code><a href="../kll/KllSketchIterator.html" title="class in org.apache.datasketches.kll">KllSketchIterator</a></code>, <code><a href="../req/ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QuantilesSketchIterator</span></div> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch. + + <p>Prototype example of the recommended iteration loop:</p> + <pre><code> + SketchIterator itr = sketch.iterator(); + while (itr.next()) { + ...get*(); + } + </code></pre></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getWeight()" class="member-name-link">getWeight</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the natural weight at the current index.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Advances the index and checks if it is valid.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getWeight()"> +<h3>getWeight</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getWeight</span>()</div> +<div class="block">Gets the natural weight at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the natural weight at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block">Advances the index and checks if it is valid. + The state of this iterator is undefined before the first call of this method.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the next index is valid.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesUtil.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesUtil.html new file mode 100644 index 000000000..fb8858597 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/QuantilesUtil.html @@ -0,0 +1,399 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuantilesUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: QuantilesUtil"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuantilesUtil.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class QuantilesUtil" class="title">Class QuantilesUtil</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.QuantilesUtil</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">QuantilesUtil</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Utilities for the quantiles sketches.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final double</code></div> +<div class="col-second even-row-color"><code><a href="#tailRoundingFactor" class="member-name-link">tailRoundingFactor</a></code></div> +<div class="col-last even-row-color"> +<div class="block">used in search to improve rounding over a wide dynamic range</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkDoublesSplitPointsOrder(double%5B%5D)" class="member-name-link">checkDoublesSplitPointsOrder</a><wbr>(double[] values)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks the sequential validity of the given array of double values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkFloatsSplitPointsOrder(float%5B%5D)" class="member-name-link">checkFloatsSplitPointsOrder</a><wbr>(float[] values)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks the sequential validity of the given array of float values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkLongsSplitPointsOrder(long%5B%5D)" class="member-name-link">checkLongsSplitPointsOrder</a><wbr>(long[] values)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks the sequential validity of the given array of double values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkNormalizedRankBounds(double)" class="member-name-link">checkNormalizedRankBounds</a><wbr>(double nRank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks that the given normalized rank: <i>0 ≤ nRank ≤ 1.0</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#equallySpacedDoubles(int)" class="member-name-link">equallySpacedDoubles</a><wbr>(int num)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array of (<i>num</i> + 1) values that define equally sized intervals between 0.0, inclusive, and 1.0, + inclusive.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#equallySpacedLongs(long,long,int)" class="member-name-link">equallySpacedLongs</a><wbr>(long min, + long max, + int num)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array of (<i>num</i> + 1) longs that define, approximately, equally spaced intervals between the given + <i>max</i>, inclusive, and <i>min</i>, inclusive.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#evenlyLogSpaced(double,double,int)" class="member-name-link">evenlyLogSpaced</a><wbr>(double value1, + double value2, + int num)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a double array of values between min and max inclusive where the log of the + returned values are evenly spaced.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#evenlySpacedDoubles(double,double,int)" class="member-name-link">evenlySpacedDoubles</a><wbr>(double value1, + double value2, + int num)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a double array of evenly spaced values between value1, inclusive, and value2 inclusive.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static float[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#evenlySpacedFloats(float,float,int)" class="member-name-link">evenlySpacedFloats</a><wbr>(float value1, + float value2, + int num)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a float array of evenly spaced values between value1, inclusive, and value2 inclusive.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNaturalRank(double,long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNaturalRank</a><wbr>(double normalizedRank, + long totalN, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the closest Natural Rank from a given Normalized Rank</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="tailRoundingFactor"> +<h3>tailRoundingFactor</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">tailRoundingFactor</span></div> +<div class="block">used in search to improve rounding over a wide dynamic range</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.quantilescommon.QuantilesUtil.tailRoundingFactor">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="checkNormalizedRankBounds(double)"> +<h3>checkNormalizedRankBounds</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">void</span> <span class="element-name">checkNormalizedRankBounds</span><wbr><span class="parameters">(double nRank)</span></div> +<div class="block">Checks that the given normalized rank: <i>0 ≤ nRank ≤ 1.0</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nRank</code> - the given normalized rank.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkDoublesSplitPointsOrder(double[])"> +<h3>checkDoublesSplitPointsOrder</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">void</span> <span class="element-name">checkDoublesSplitPointsOrder</span><wbr><span class="parameters">(double[] values)</span></div> +<div class="block">Checks the sequential validity of the given array of double values. + They must be unique, monotonically increasing and not NaN.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>values</code> - the given array of double values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkLongsSplitPointsOrder(long[])"> +<h3>checkLongsSplitPointsOrder</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkLongsSplitPointsOrder</span><wbr><span class="parameters">(long[] values)</span></div> +<div class="block">Checks the sequential validity of the given array of double values. + They must be unique and monotonically increasing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>values</code> - the given array of double values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkFloatsSplitPointsOrder(float[])"> +<h3>checkFloatsSplitPointsOrder</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">void</span> <span class="element-name">checkFloatsSplitPointsOrder</span><wbr><span class="parameters">(float[] values)</span></div> +<div class="block">Checks the sequential validity of the given array of float values. + They must be unique, monotonically increasing and not NaN.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>values</code> - the given array of double values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="equallySpacedDoubles(int)"> +<h3>equallySpacedDoubles</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double[]</span> <span class="element-name">equallySpacedDoubles</span><wbr><span class="parameters">(int num)</span></div> +<div class="block">Returns an array of (<i>num</i> + 1) values that define equally sized intervals between 0.0, inclusive, and 1.0, + inclusive. The end points 0.0 and 1.0 are part of the returned array. + + <p>For example, if num == 2, three values will be returned: 0.0, .5, and 1, where the two equally sized regions + are {0.0,0.5}, and {0.5, 1.0}.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>num</code> - the total number of equally sized intervals between 0.0, inclusive and 1.0, inclusive. + Must be 1 or greater.</dd> +<dt>Returns:</dt> +<dd>a double array of values that define (num + 1) equally sized intervals between 0.0, inclusive and 1.0, + inclusive.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <i>num</i> is less than 1.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="equallySpacedLongs(long,long,int)"> +<h3>equallySpacedLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">equallySpacedLongs</span><wbr><span class="parameters">(long min, + long max, + int num)</span></div> +<div class="block">Returns an array of (<i>num</i> + 1) longs that define, approximately, equally spaced intervals between the given + <i>max</i>, inclusive, and <i>min</i>, inclusive. The end points <i>max</i> and <i>min</i> are part of the + returned array. Because the range of the values may not exactly divide into <i>num</i> intervals, + the size of these intervals may vary by plus or minus one.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>min</code> - the lowest positive valued (or zero) number of the range</dd> +<dd><code>max</code> - the highest positive valued number of the range. <i>max</i> must be greater than <i>min</i></dd> +<dd><code>num</code> - Number of requested intervals. Must be greater or equal to one, and less than or equal to + <i>max - min</i>.</dd> +<dt>Returns:</dt> +<dd>an array of (<i>num</i> + 1) longs that are approximately equally spaced between the given min and max.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="evenlySpacedFloats(float,float,int)"> +<h3>evenlySpacedFloats</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">float[]</span> <span class="element-name">evenlySpacedFloats</span><wbr><span class="parameters">(float value1, + float value2, + int num)</span></div> +<div class="block">Returns a float array of evenly spaced values between value1, inclusive, and value2 inclusive. + If value2 > value1, the resulting sequence will be increasing. + If value2 < value1, the resulting sequence will be decreasing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value1</code> - will be in index 0 of the returned array</dd> +<dd><code>value2</code> - will be in the highest index of the returned array</dd> +<dd><code>num</code> - the total number of values including value1 and value2. Must be 2 or greater.</dd> +<dt>Returns:</dt> +<dd>a float array of evenly spaced values between value1, inclusive, and value2 inclusive.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="evenlySpacedDoubles(double,double,int)"> +<h3>evenlySpacedDoubles</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double[]</span> <span class="element-name">evenlySpacedDoubles</span><wbr><span class="parameters">(double value1, + double value2, + int num)</span></div> +<div class="block">Returns a double array of evenly spaced values between value1, inclusive, and value2 inclusive. + If value2 > value1, the resulting sequence will be increasing. + If value2 < value1, the resulting sequence will be decreasing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value1</code> - will be in index 0 of the returned array</dd> +<dd><code>value2</code> - will be in the highest index of the returned array</dd> +<dd><code>num</code> - the total number of values including value1 and value2. Must be 2 or greater.</dd> +<dt>Returns:</dt> +<dd>a float array of evenly spaced values between value1, inclusive, and value2 inclusive.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="evenlyLogSpaced(double,double,int)"> +<h3>evenlyLogSpaced</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double[]</span> <span class="element-name">evenlyLogSpaced</span><wbr><span class="parameters">(double value1, + double value2, + int num)</span></div> +<div class="block">Returns a double array of values between min and max inclusive where the log of the + returned values are evenly spaced. + If value2 > value1, the resulting sequence will be increasing. + If value2 < value1, the resulting sequence will be decreasing.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value1</code> - will be in index 0 of the returned array, and must be greater than zero.</dd> +<dd><code>value2</code> - will be in the highest index of the returned array, and must be greater than zero.</dd> +<dd><code>num</code> - the total number of values including value1 and value2. Must be 2 or greater</dd> +<dt>Returns:</dt> +<dd>a double array of exponentially spaced values between value1 and value2 inclusive.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNaturalRank(double,long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getNaturalRank</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getNaturalRank</span><wbr><span class="parameters">(double normalizedRank, + long totalN, + <a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Computes the closest Natural Rank from a given Normalized Rank</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>normalizedRank</code> - the given normalized rank</dd> +<dd><code>totalN</code> - the total N</dd> +<dd><code>searchCrit</code> - the search criterion.</dd> +<dt>Returns:</dt> +<dd>the closest Natural Rank from a given Normalized Rank</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/SketchPartitionLimits.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/SketchPartitionLimits.html new file mode 100644 index 000000000..f2018273d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/SketchPartitionLimits.html @@ -0,0 +1,181 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SketchPartitionLimits (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: SketchPartitionLimits"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SketchPartitionLimits.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface SketchPartitionLimits" class="title">Interface SketchPartitionLimits</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Subinterfaces:</dt> +<dd><code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></code>, <code><a href="QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></code>, <code><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></code>, <code><a href="../kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SketchPartitionLimits</span></div> +<div class="block">This defines the methods required to compute the partition limits.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxPartitions()" class="member-name-link">getMaxPartitions</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the maximum number of partitions this sketch will support based on the configured size <i>K</i> + and the number of retained values of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getMinPartitionSizeItems()" class="member-name-link">getMinPartitionSizeItems</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> +<div class="block">Gets the minimum partition size in items this sketch will support based on the configured size <i>K</i> of this + sketch and the number of retained values of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getMaxPartitions()"> +<h3>getMaxPartitions</h3> +<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getMaxPartitions</span>()</div> +<div class="block">Gets the maximum number of partitions this sketch will support based on the configured size <i>K</i> + and the number of retained values of this sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum number of partitions this sketch will support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinPartitionSizeItems()"> +<h3>getMinPartitionSizeItems</h3> +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name">getMinPartitionSizeItems</span>()</div> +<div class="block">Gets the minimum partition size in items this sketch will support based on the configured size <i>K</i> of this + sketch and the number of retained values of this sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the minimum partition size in items this sketch will support.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the length of the input stream offered to the sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/SortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/SortedView.html new file mode 100644 index 000000000..c454d94ba --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/SortedView.html @@ -0,0 +1,223 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, interface: SortedView"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SortedView.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Interface SortedView" class="title">Interface SortedView</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Subinterfaces:</dt> +<dd><code><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code>, <code><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code>, <code><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></code>, <code><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code>, <code><a href="FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code>, <code><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></code>, <code><a href="LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SortedView</span></div> +<div class="block">This is the base interface for the Sorted View interface hierarchy and defines the methods that are type independent. + + <p>The SortedView interface hierarchy provides a sorted view of the data retained by a quantiles-type sketch that + would be cumbersome to get any other way. + One could use the sketch's iterator to iterate over the contents of the sketch, + but the result would not be sorted.</p> + + <p>The data from a Sorted view is an unbiased random sample of the input stream that can be used for other kinds of + analysis not directly provided by the sketch.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCumulativeWeights()" class="member-name-link">getCumulativeWeights</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the array of cumulative weights from the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the number of quantiles retained by this sorted view.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sorted view is empty.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCumulativeWeights()"> +<h3>getCumulativeWeights</h3> +<div class="member-signature"><span class="return-type">long[]</span> <span class="element-name">getCumulativeWeights</span>()</div> +<div class="block">Returns the array of cumulative weights from the sketch. + Also known as the natural ranks, which are the Natural Numbers on the interval [1, N].</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the array of cumulative weights (or natural ranks).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Returns the total number of items presented to the sourcing sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the total number of items presented to the sourcing sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block">Gets the number of quantiles retained by this sorted view. + This may be slightly different from the function with the same name when called from the originating sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of quantiles retained by this sorted view</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if this sorted view is empty.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sorted view is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="return-type"><a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block">Returns an iterator for this Sorted View.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an iterator for this Sorted View.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/SortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/SortedViewIterator.html new file mode 100644 index 000000000..648045bab --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/SortedViewIterator.html @@ -0,0 +1,285 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon, class: SortedViewIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SortedViewIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></div> +<h1 title="Class SortedViewIterator" class="title">Class SortedViewIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.quantilescommon.SortedViewIterator</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></code>, <code><a href="FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></code>, <code><a href="GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></code>, <code><a href="LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SortedViewIterator</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This is the base interface for the SortedViewIterator hierarchy used with a SortedView obtained + from a quantile-type sketch. This provides an ordered iterator over the retained quantiles of + the associated quantile-type sketch. + + <p>Prototype example of the recommended iteration loop:</p> + <pre><code> + SortedViewIterator itr = sketch.getSortedView().iterator(); + while (itr.next()) { + long weight = itr.getWeight(); + ... + } + </code></pre></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Alexander Saydakov, Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the total count of all items presented to the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNaturalRank()" class="member-name-link">getNaturalRank</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the natural rank at the current index.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNaturalRank</a><wbr>(<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the natural rank at the current index (or previous index) based on the chosen search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNormalizedRank()" class="member-name-link">getNormalizedRank</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank at the current index.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNormalizedRank</a><wbr>(<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank at the current index (or previous index) + based on the chosen search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWeight()" class="member-name-link">getWeight</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the weight contribution of the item at the current index.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Advances the index and checks if it is valid.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getNaturalRank()"> +<h3>getNaturalRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getNaturalRank</span>()</div> +<div class="block">Gets the natural rank at the current index. + This is equivalent to <i>getNaturalRank(INCLUSIVE)</i>. + + <p>Don't call this before calling next() for the first time or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the natural rank at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getNaturalRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getNaturalRank</span><wbr><span class="parameters">(<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the natural rank at the current index (or previous index) based on the chosen search criterion. + This is also referred to as the "cumulative weight". The natural rank is a number in the range <i>[1, N]</i>, + where <i>N</i> (<a href="#getN()"><code>getN()</code></a>) is the total number of items fed to the sketch. + + <p>Don't call this before calling next() for the first time or after getting false from next().</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>searchCrit</code> - if INCLUSIVE, includes the weight of the item at the current index in the computation of + the natural rank. + Otherwise, it will return the natural rank of the previous index.</dd> +<dt>Returns:</dt> +<dd>the natural rank at the current index (or previous index) based on the chosen search criterion.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Gets the total count of all items presented to the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the total count of all items presented to the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRank()"> +<h3>getNormalizedRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRank</span>()</div> +<div class="block">Gets the normalized rank at the current index. + This is equivalent to <i>getNormalizedRank(INCLUSIVE)</i>. + + <p>Don't call this before calling next() for the first time or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the normalized rank at the current index</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getNormalizedRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRank</span><wbr><span class="parameters">(<a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block">Gets the normalized rank at the current index (or previous index) + based on the chosen search criterion. Where <i>normalized rank = natural rank / N</i> (<a href="#getN()"><code>getN()</code></a>) + and is a fraction in the range (0,1.0]. + + <p>Don't call this before calling next() for the first time or after getting false from next().</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>searchCrit</code> - if INCLUSIVE, includes the normalized rank at the current index. + Otherwise, returns the normalized rank of the previous index.</dd> +<dt>Returns:</dt> +<dd>the normalized rank at the current index (or previous index) + based on the chosen search criterion.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getWeight()"> +<h3>getWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getWeight</span>()</div> +<div class="block">Gets the weight contribution of the item at the current index. + + <p>Don't call this before calling next() for the first time or after getting false from next().</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the weight contribution of the item at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block">Advances the index and checks if it is valid. + The state of this iterator is undefined before the first call of this method.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the next index is valid.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/BinarySearch.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/BinarySearch.html new file mode 100644 index 000000000..a30e6177a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/BinarySearch.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.BinarySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: BinarySearch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.BinarySearch" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.BinarySearch</h1> +</div> +No usage of org.apache.datasketches.quantilescommon.BinarySearch</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSketchSortedView.html new file mode 100644 index 000000000..0a6169d65 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSketchSortedView.html @@ -0,0 +1,109 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.DoublesSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: DoublesSketchSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.DoublesSketchSortedView" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.DoublesSketchSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final <a href="../DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSortedView.html new file mode 100644 index 000000000..6da204ef8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSortedView.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.DoublesSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: DoublesSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.DoublesSortedView" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.DoublesSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that implement <a href="../DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../DoublesSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSortedViewIterator.html new file mode 100644 index 000000000..938709ad1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/DoublesSortedViewIterator.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.DoublesSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: DoublesSortedViewIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.DoublesSortedViewIterator" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.DoublesSortedViewIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketchSortedView.</span><code><a href="../DoublesSketchSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesSortedView.</span><code><a href="../DoublesSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSketchSortedView.html new file mode 100644 index 000000000..b6fdd997f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSketchSortedView.html @@ -0,0 +1,108 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.FloatsSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: FloatsSketchSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.FloatsSketchSortedView" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.FloatsSketchSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Methods in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that return <a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSortedView.html new file mode 100644 index 000000000..3e2411a9d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSortedView.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.FloatsSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: FloatsSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.FloatsSortedView" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.FloatsSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that implement <a href="../FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../FloatsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSortedViewIterator.html new file mode 100644 index 000000000..59a5d9625 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/FloatsSortedViewIterator.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.FloatsSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: FloatsSortedViewIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.FloatsSortedViewIterator" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.FloatsSortedViewIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">FloatsSketchSortedView.</span><code><a href="../FloatsSketchSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">FloatsSortedView.</span><code><a href="../FloatsSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericInequalitySearch.Inequality.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericInequalitySearch.Inequality.html new file mode 100644 index 000000000..d3ef487c1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericInequalitySearch.Inequality.html @@ -0,0 +1,115 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: GenericInequalitySearch, enum: Inequality"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality" class="title">Uses of Enum Class<br>org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality</h1> +</div> +<div class="caption"><span>Packages that use <a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">GenericInequalitySearch.Inequality.</span><code><a href="../GenericInequalitySearch.Inequality.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">GenericInequalitySearch.Inequality.</span><code><a href="../GenericInequalitySearch.Inequality.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">GenericInequalitySearch.</span><code><a href="../GenericInequalitySearch.html#find(T%5B%5D,int,int,T,org.apache.datasketches.quantilescommon.GenericInequalitySearch.Inequality,java.util.Comparator)" class="member-name-link">find</a><wbr>(T[] arr, + int low, + int high, + T v, + <a href="../GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a> crit, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><T> comparator)</code></div> +<div class="col-last even-row-color"> +<div class="block">Binary Search for the index of the generic value in the given search range that satisfies + the given Inequality criterion.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericInequalitySearch.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericInequalitySearch.html new file mode 100644 index 000000000..64ecb1107 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericInequalitySearch.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.GenericInequalitySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: GenericInequalitySearch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../GenericInequalitySearch.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.GenericInequalitySearch" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.GenericInequalitySearch</h1> +</div> +No usage of org.apache.datasketches.quantilescommon.GenericInequalitySearch</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericPartitionBoundaries.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericPartitionBoundaries.html new file mode 100644 index 000000000..51f296266 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericPartitionBoundaries.html @@ -0,0 +1,208 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.GenericPartitionBoundaries (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: GenericPartitionBoundaries"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.GenericPartitionBoundaries" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.GenericPartitionBoundaries</h1> +</div> +<div class="caption"><span>Packages that use <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a> in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Fields in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a> declared as <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../partitions/Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Partitioner.StackElement.</span><code><a href="../../partitions/Partitioner.StackElement.html#gpb" class="member-name-link">gpb</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A reference to the relevant GenericPartitionBoundaries class</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a> with parameters of type <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../../partitions/Partitioner.StackElement.html#%3Cinit%3E(org.apache.datasketches.quantilescommon.GenericPartitionBoundaries,int,java.lang.String)" class="member-name-link">StackElement</a><wbr>(<a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../partitions/Partitioner.StackElement.html" title="type parameter in Partitioner.StackElement">T</a>> gpb, + int part, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> levelPartId)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs this StackElement</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>default <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">PartitioningFeature.</span><code><a href="../PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This method returns an instance of + <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">PartitioningFeature.</span><code><a href="../PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">This method returns an instance of + <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartitionSize, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>default <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">PartitioningFeature.</span><code><a href="../PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems)</code></div> +<div class="col-last even-row-color"> +<div class="block">This method returns an instance of + <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">PartitioningFeature.</span><code><a href="../PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This method returns an instance of + <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericSortedView.html new file mode 100644 index 000000000..401164a54 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericSortedView.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.GenericSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: GenericSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.GenericSortedView" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.GenericSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that implement <a href="../GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ItemsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericSortedViewIterator.html new file mode 100644 index 000000000..63f782c5b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/GenericSortedViewIterator.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.GenericSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: GenericSortedViewIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.GenericSortedViewIterator" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.GenericSortedViewIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="../GenericSortedView.html" title="type parameter in GenericSortedView">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">GenericSortedView.</span><code><a href="../GenericSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.DoublesPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.DoublesPair.html new file mode 100644 index 000000000..a650fd0ab --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.DoublesPair.html @@ -0,0 +1,95 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.DoublesPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: DoublesPair"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.DoublesPair" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.IncludeMinMax.DoublesPair</h1> +</div> +<div class="caption"><span>Packages that use <a href="../IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IncludeMinMax.</span><code><a href="../IncludeMinMax.html#includeDoublesMinMax(double%5B%5D,long%5B%5D,double,double)" class="member-name-link">includeDoublesMinMax</a><wbr>(double[] quantilesIn, + long[] cumWeightsIn, + double maxItem, + double minItem)</code></div> +<div class="col-last even-row-color"> +<div class="block">The logic to include the min and max of type double.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.FloatsPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.FloatsPair.html new file mode 100644 index 000000000..8ba32ac68 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.FloatsPair.html @@ -0,0 +1,95 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.FloatsPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: FloatsPair"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.FloatsPair" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.IncludeMinMax.FloatsPair</h1> +</div> +<div class="caption"><span>Packages that use <a href="../IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IncludeMinMax.</span><code><a href="../IncludeMinMax.html#includeFloatsMinMax(float%5B%5D,long%5B%5D,float,float)" class="member-name-link">includeFloatsMinMax</a><wbr>(float[] quantilesIn, + long[] cumWeightsIn, + float maxItem, + float minItem)</code></div> +<div class="col-last even-row-color"> +<div class="block">The logic to include the min and max of type float.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.ItemsPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.ItemsPair.html new file mode 100644 index 000000000..16f79922e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.ItemsPair.html @@ -0,0 +1,96 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.ItemsPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: ItemsPair"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.ItemsPair" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.IncludeMinMax.ItemsPair</h1> +</div> +<div class="caption"><span>Packages that use <a href="../IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IncludeMinMax.</span><code><a href="../IncludeMinMax.html#includeItemsMinMax(T%5B%5D,long%5B%5D,T,T,java.util.Comparator)" class="member-name-link">includeItemsMinMax</a><wbr>(T[] quantilesIn, + long[] cumWeightsIn, + T maxItem, + T minItem, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><? super T> comparator)</code></div> +<div class="col-last even-row-color"> +<div class="block">The logic to include the min and max of type T.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.LongsPair.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.LongsPair.html new file mode 100644 index 000000000..61ae8e2d7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.LongsPair.html @@ -0,0 +1,95 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.LongsPair (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax, class: LongsPair"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax.LongsPair" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.IncludeMinMax.LongsPair</h1> +</div> +<div class="caption"><span>Packages that use <a href="../IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IncludeMinMax.</span><code><a href="../IncludeMinMax.html#includeLongsMinMax(long%5B%5D,long%5B%5D,long,long)" class="member-name-link">includeLongsMinMax</a><wbr>(long[] quantilesIn, + long[] cumWeightsIn, + long maxItem, + long minItem)</code></div> +<div class="col-last even-row-color"> +<div class="block">The logic to include the min and max of type double.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.html new file mode 100644 index 000000000..346333339 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/IncludeMinMax.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: IncludeMinMax"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.IncludeMinMax" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.IncludeMinMax</h1> +</div> +No usage of org.apache.datasketches.quantilescommon.IncludeMinMax</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/InequalitySearch.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/InequalitySearch.html new file mode 100644 index 000000000..6137a18e7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/InequalitySearch.html @@ -0,0 +1,144 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.quantilescommon.InequalitySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, enum: InequalitySearch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.quantilescommon.InequalitySearch" class="title">Uses of Enum Class<br>org.apache.datasketches.quantilescommon.InequalitySearch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">InequalitySearch.</span><code><a href="../InequalitySearch.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">InequalitySearch.</span><code><a href="../InequalitySearch.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">InequalitySearch.</span><code><a href="../InequalitySearch.html#find(double%5B%5D,int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(double[] arr, + int low, + int high, + double v, + <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +<div class="col-first odd-row-color"><code>static int</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">InequalitySearch.</span><code><a href="../InequalitySearch.html#find(float%5B%5D,int,int,float,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(float[] arr, + int low, + int high, + float v, + <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Binary Search for the index of the float value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +<div class="col-first even-row-color"><code>static int</code></div> +<div class="col-second even-row-color"><span class="type-name-label">InequalitySearch.</span><code><a href="../InequalitySearch.html#find(long%5B%5D,int,int,double,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(long[] arr, + int low, + int high, + double v, + <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Binary Search for the index of the double value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +<div class="col-first odd-row-color"><code>static int</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">InequalitySearch.</span><code><a href="../InequalitySearch.html#find(long%5B%5D,int,int,long,org.apache.datasketches.quantilescommon.InequalitySearch)" class="member-name-link">find</a><wbr>(long[] arr, + int low, + int high, + long v, + <a href="../InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a> crit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Binary Search for the index of the long value in the given search range that satisfies + the given InequalitySearch criterion.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/ItemsSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/ItemsSketchSortedView.html new file mode 100644 index 000000000..18bb8d9f3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/ItemsSketchSortedView.html @@ -0,0 +1,109 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.ItemsSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: ItemsSketchSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.ItemsSketchSortedView" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.ItemsSketchSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final <a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/KolmogorovSmirnov.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/KolmogorovSmirnov.html new file mode 100644 index 000000000..ed4917e25 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/KolmogorovSmirnov.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.KolmogorovSmirnov (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: KolmogorovSmirnov"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.KolmogorovSmirnov" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.KolmogorovSmirnov</h1> +</div> +No usage of org.apache.datasketches.quantilescommon.KolmogorovSmirnov</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSketchSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSketchSortedView.html new file mode 100644 index 000000000..72b8cc7bd --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSketchSortedView.html @@ -0,0 +1,90 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.LongsSketchSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: LongsSketchSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.LongsSketchSortedView" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.LongsSketchSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSortedView.html new file mode 100644 index 000000000..0514d4970 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSortedView.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.LongsSortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: LongsSortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.LongsSortedView" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.LongsSortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that implement <a href="../LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../LongsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView of the KllLongsSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSortedViewIterator.html new file mode 100644 index 000000000..bd7c3f115 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/LongsSortedViewIterator.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.LongsSortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: LongsSortedViewIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.LongsSortedViewIterator" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.LongsSortedViewIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketchSortedView.</span><code><a href="../LongsSketchSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">LongsSortedView.</span><code><a href="../LongsSortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/PartitioningFeature.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/PartitioningFeature.html new file mode 100644 index 000000000..a32eaea11 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/PartitioningFeature.html @@ -0,0 +1,177 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.PartitioningFeature (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: PartitioningFeature"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.PartitioningFeature" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.PartitioningFeature</h1> +</div> +<div class="caption"><span>Packages that use <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a> in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Classes in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a> with type parameters of type <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../partitions/Partitioner.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner</a><T,<wbr>S extends <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></code></div> +<div class="col-last even-row-color"> +<div class="block">A partitioning process that can partition very large data sets into thousands + of partitions of approximately the same size.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../../partitions/SketchFillRequest.html" class="type-name-link" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><T,<wbr>S extends <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></code></div> +<div class="col-last odd-row-color"> +<div class="block">This is a callback request to the data source to fill a quantiles sketch, + which is returned to the caller.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Subinterfaces of <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Interface</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The Sorted View for quantiles of generic type.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +</div> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that implement <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ItemsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantileSearchCriteria.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantileSearchCriteria.html new file mode 100644 index 000000000..e0f533c48 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantileSearchCriteria.html @@ -0,0 +1,742 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.quantilescommon.QuantileSearchCriteria (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, enum: QuantileSearchCriteria"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.quantilescommon.QuantileSearchCriteria" class="title">Uses of Enum Class<br>org.apache.datasketches.quantilescommon.QuantileSearchCriteria</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> with parameters of type <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(long[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(long[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>float</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>long</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>float[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>long[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a> quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(double[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(float[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(long[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Constructors in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a> with parameters of type <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../../partitions/Partitioner.html#%3Cinit%3E(long,int,org.apache.datasketches.partitions.SketchFillRequest,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">Partitioner</a><wbr>(long tgtPartitionSize, + int maxPartsPerSk, + <a href="../../partitions/SketchFillRequest.html" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><<a href="../../partitions/Partitioner.html" title="type parameter in Partitioner">T</a>,<wbr><a href="../../partitions/Partitioner.html" title="type parameter in Partitioner">S</a>> fillReq, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> criteria)</code></div> +<div class="col-last even-row-color"> +<div class="block">This constructor includes the QuantileSearchCriteria criteria as a parameter.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Methods in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> with parameters of type <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a> quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(double[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">GenericPartitionBoundaries.</span><code><a href="../GenericPartitionBoundaries.html#getSearchCriteria()" class="member-name-link">getSearchCriteria</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the search criteria specified for the source sketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantileSearchCriteria.</span><code><a href="../QuantileSearchCriteria.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantileSearchCriteria.</span><code><a href="../QuantileSearchCriteria.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>default double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSortedView.</span><code><a href="../DoublesSortedView.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>default double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">FloatsSortedView.</span><code><a href="../FloatsSortedView.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>default double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">GenericSortedView.</span><code><a href="../GenericSortedView.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="../GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>default double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">LongsSortedView.</span><code><a href="../LongsSortedView.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(long[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#getCDF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#getCDF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(long[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>static double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesUtil.</span><code><a href="../QuantilesUtil.html#getNaturalRank(double,long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNaturalRank</a><wbr>(double normalizedRank, + long totalN, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes the closest Natural Rank from a given Normalized Rank</div> +</div> +<div class="col-first odd-row-color"><code>long</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SortedViewIterator.</span><code><a href="../SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNaturalRank</a><wbr>(<a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the natural rank at the current index (or previous index) based on the chosen search criterion.</div> +</div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">SortedViewIterator.</span><code><a href="../SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getNormalizedRank</a><wbr>(<a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the normalized rank at the current index (or previous index) + based on the chosen search criterion.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">PartitioningFeature.</span><code><a href="../PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromNumParts</a><wbr>(int numEquallySizedParts, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">This method returns an instance of + <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartitionSize, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><<a href="../PartitioningFeature.html" title="type parameter in PartitioningFeature">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">PartitioningFeature.</span><code><a href="../PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPartitionBoundariesFromPartSize</a><wbr>(long nominalPartSizeItems, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">This method returns an instance of + <a href="../GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>GenericPartitionBoundaries</code></a> which provides + sufficient information for the user to create the given number of equally sized partitions, where "equally sized" + refers to an approximately equal number of items per partition.</div> +</div> +<div class="col-first odd-row-color"><code>default double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesSortedView.</span><code><a href="../DoublesSortedView.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>default double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">FloatsSortedView.</span><code><a href="../FloatsSortedView.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>default double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">GenericSortedView.</span><code><a href="../GenericSortedView.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="../GenericSortedView.html" title="type parameter in GenericSortedView">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>default double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSortedView.</span><code><a href="../LongsSortedView.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(long[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#getPMF(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#getPMF(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(long[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesSketchSortedView.</span><code><a href="../DoublesSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSortedView.</span><code><a href="../DoublesSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color"><code>float</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">FloatsSketchSortedView.</span><code><a href="../FloatsSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>float</code></div> +<div class="col-second even-row-color"><span class="type-name-label">FloatsSortedView.</span><code><a href="../FloatsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../GenericSortedView.html" title="type parameter in GenericSortedView">T</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">GenericSortedView.</span><code><a href="../GenericSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color"><code><a href="../GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">GenericSortedViewIterator.</span><code><a href="../GenericSortedViewIterator.html#getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(<a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the quantile at the current index (or previous index) + based on the chosen search criterion.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>long</code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSketchSortedView.</span><code><a href="../LongsSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>long</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">LongsSortedView.</span><code><a href="../LongsSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color"><code>float</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color"><code><a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color"><code>long</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double rank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first even-row-color"><code><a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets an array of quantiles corresponding to the given array of ranks.</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first even-row-color"><code>float[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first even-row-color"><code>long[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] ranks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoublesSketchSortedView.</span><code><a href="../DoublesSketchSortedView.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSortedView.</span><code><a href="../DoublesSortedView.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">FloatsSketchSortedView.</span><code><a href="../FloatsSketchSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">FloatsSortedView.</span><code><a href="../FloatsSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">GenericSortedView.</span><code><a href="../GenericSortedView.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="../GenericSortedView.html" title="type parameter in GenericSortedView">T</a> quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketchSortedView.</span><code><a href="../ItemsSketchSortedView.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a> quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">LongsSketchSortedView.</span><code><a href="../LongsSketchSortedView.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">LongsSortedView.</span><code><a href="../LongsSortedView.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(double quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color"><code>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#getRank(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(long quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(double[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(float[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#getRanks(long%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(long[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../GenericPartitionBoundaries.html#%3Cinit%3E(long,T%5B%5D,long%5B%5D,double%5B%5D,T,T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">GenericPartitionBoundaries</a><wbr>(long totalN, + <a href="../GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a>[] boundaries, + long[] natRanks, + double[] normRanks, + <a href="../GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a> maxItem, + <a href="../GenericPartitionBoundaries.html" title="type parameter in GenericPartitionBoundaries">T</a> minItem, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Methods in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> with parameters of type <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>float</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double normRank, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>float[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] normRanks, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(float[] quantiles, + <a href="../QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesAPI.html new file mode 100644 index 000000000..2ff4e9a7c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesAPI.html @@ -0,0 +1,228 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesAPI"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesAPI" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesAPI</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../kll/KllFloatsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../kll/KllLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This class is the root of the KLL sketch class hierarchy.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/CompactDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../quantiles/DoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../quantiles/UpdateDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Subinterfaces of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Interface</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../QuantilesDoublesAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../QuantilesFloatsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../QuantilesLongsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>long</i>.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KolmogorovSmirnov.</span><code><a href="../KolmogorovSmirnov.html#computeKSThreshold(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)" class="member-name-link">computeKSThreshold</a><wbr>(<a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch1, + <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch2, + double tgtPvalue)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes the adjusted delta height threshold for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</div> +<div class="col-first odd-row-color"><code>static boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">KolmogorovSmirnov.</span><code><a href="../KolmogorovSmirnov.html#kolmogorovSmirnovTest(org.apache.datasketches.quantilescommon.QuantilesAPI,org.apache.datasketches.quantilescommon.QuantilesAPI,double)" class="member-name-link">kolmogorovSmirnovTest</a><wbr>(<a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch1, + <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> sketch2, + double tgtPvalue)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Performs the Kolmogorov-Smirnov Test between two QuantilesAPI sketches.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Classes in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that implement <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../req/ReqSketch.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper + "Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty, + Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesDoublesAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesDoublesAPI.html new file mode 100644 index 000000000..932a7df40 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesDoublesAPI.html @@ -0,0 +1,158 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesDoublesAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesDoublesAPI"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesDoublesAPI" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesDoublesAPI</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements primitive doubles.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/CompactDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Compact sketches are inherently <i>read only</i>.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../../quantiles/DoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/UpdateDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KolmogorovSmirnov.</span><code><a href="../KolmogorovSmirnov.html#computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesDoublesAPI,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)" class="member-name-link">computeKSDelta</a><wbr>(<a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sketch1, + <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sketch2)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes the raw delta between two QuantilesDoublesAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../DoublesSketchSortedView.html#%3Cinit%3E(double%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesDoublesAPI)" class="member-name-link">DoublesSketchSortedView</a><wbr>(double[] quantiles, + long[] cumWeights, + <a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct from elements, also used in testing.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesDoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesDoublesSketchIterator.html new file mode 100644 index 000000000..072b077f8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesDoublesSketchIterator.html @@ -0,0 +1,152 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesDoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesDoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesDoublesSketchIterator" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesDoublesSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllDoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllDoublesSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllDoublesSketch.</span><code><a href="../../kll/KllDoublesSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/DoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over DoublesSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoublesSketch.</span><code><a href="../../quantiles/DoublesSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesDoublesAPI.</span><code><a href="../QuantilesDoublesAPI.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesFloatsAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesFloatsAPI.html new file mode 100644 index 000000000..9cc510e34 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesFloatsAPI.html @@ -0,0 +1,149 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesFloatsAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesFloatsAPI"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesFloatsAPI" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesFloatsAPI</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllFloatsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements primitive floats.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">KolmogorovSmirnov.</span><code><a href="../KolmogorovSmirnov.html#computeKSDelta(org.apache.datasketches.quantilescommon.QuantilesFloatsAPI,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)" class="member-name-link">computeKSDelta</a><wbr>(<a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sketch1, + <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sketch2)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes the raw delta between two QuantilesFloatsAPI sketches for the <i>kolmogorovSmirnovTest(...)</i> method.</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../FloatsSketchSortedView.html#%3Cinit%3E(float%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesFloatsAPI)" class="member-name-link">FloatsSketchSortedView</a><wbr>(float[] quantiles, + long[] cumWeights, + <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct Sorted View.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Classes in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that implement <a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../req/ReqSketch.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper + "Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty, + Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesFloatsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesFloatsSketchIterator.html new file mode 100644 index 000000000..fe36dc972 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesFloatsSketchIterator.html @@ -0,0 +1,151 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesFloatsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesFloatsSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesFloatsSketchIterator" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesFloatsSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllFloatsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllFloatsSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllFloatsSketch.</span><code><a href="../../kll/KllFloatsSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesFloatsAPI.</span><code><a href="../QuantilesFloatsAPI.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Classes in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that implement <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../req/ReqSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over all retained items of the ReqSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that return <a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../../req/ReqSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesGenericAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesGenericAPI.html new file mode 100644 index 000000000..ea61c36a7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesGenericAPI.html @@ -0,0 +1,163 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesGenericAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesGenericAPI"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesGenericAPI" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesGenericAPI</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<h2>Uses of <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a> in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a></h2> +<div class="caption"><span>Classes in <a href="../../partitions/package-summary.html">org.apache.datasketches.partitions</a> with type parameters of type <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../partitions/Partitioner.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner</a><T,<wbr>S extends <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></code></div> +<div class="col-last even-row-color"> +<div class="block">A partitioning process that can partition very large data sets into thousands + of partitions of approximately the same size.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../../partitions/SketchFillRequest.html" class="type-name-link" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><T,<wbr>S extends <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> & <a href="../PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>></code></div> +<div class="col-last odd-row-color"> +<div class="block">This is a callback request to the data source to fill a quantiles sketch, + which is returned to the caller.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../ItemsSketchSortedView.html#%3Cinit%3E(T%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesGenericAPI)" class="member-name-link">ItemsSketchSortedView</a><wbr>(<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>[] quantiles, + long[] cumWeights, + <a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><<a href="../ItemsSketchSortedView.html" title="type parameter in ItemsSketchSortedView">T</a>> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesGenericSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesGenericSketchIterator.html new file mode 100644 index 000000000..a065dc9ad --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesGenericSketchIterator.html @@ -0,0 +1,152 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesGenericSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesGenericSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesGenericSketchIterator" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesGenericSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllItemsSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="../../kll/KllItemsSketch.html" title="type parameter in KllItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllItemsSketch.</span><code><a href="../../kll/KllItemsSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/ItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over ItemsSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that return <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="../../quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ItemsSketch.</span><code><a href="../../quantiles/ItemsSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesGenericAPI.</span><code><a href="../QuantilesGenericAPI.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesLongsAPI.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesLongsAPI.html new file mode 100644 index 000000000..614e8e90b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesLongsAPI.html @@ -0,0 +1,115 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesLongsAPI (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesLongsAPI"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesLongsAPI" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesLongsAPI</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements primitive longs.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> with parameters of type <a href="../QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../LongsSketchSortedView.html#%3Cinit%3E(long%5B%5D,long%5B%5D,org.apache.datasketches.quantilescommon.QuantilesLongsAPI)" class="member-name-link">LongsSketchSortedView</a><wbr>(long[] quantiles, + long[] cumWeights, + <a href="../QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct from elements, also used in testing.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesLongsSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesLongsSketchIterator.html new file mode 100644 index 000000000..327b5bfb3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesLongsSketchIterator.html @@ -0,0 +1,122 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesLongsSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesLongsSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesLongsSketchIterator" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesLongsSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllLongsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllLongsSketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that return <a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">KllLongsSketch.</span><code><a href="../../kll/KllLongsSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">QuantilesLongsAPI.</span><code><a href="../QuantilesLongsAPI.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesSketchIterator.html new file mode 100644 index 000000000..06f076eb2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesSketchIterator.html @@ -0,0 +1,195 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: QuantilesSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesSketchIterator" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllDoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllDoublesSketch.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../../kll/KllFloatsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over KllFloatsSketch.</div> +</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over KllItemsSketch.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../../kll/KllLongsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over KllLongsSketch.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The base implementation for the KLL sketch iterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/DoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over DoublesSketch.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../../quantiles/ItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><T></code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over ItemsSketch.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Subinterfaces of <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Interface</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../QuantilesDoublesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../QuantilesFloatsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../QuantilesGenericSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles sketch iterator for generic types.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../QuantilesLongsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for primitive type long.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Classes in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that implement <a href="../QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../req/ReqSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over all retained items of the ReqSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesUtil.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesUtil.html new file mode 100644 index 000000000..765cc6b99 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/QuantilesUtil.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.QuantilesUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: QuantilesUtil"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.QuantilesUtil" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.QuantilesUtil</h1> +</div> +No usage of org.apache.datasketches.quantilescommon.QuantilesUtil</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SketchPartitionLimits.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SketchPartitionLimits.html new file mode 100644 index 000000000..7c6b0ae7e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SketchPartitionLimits.html @@ -0,0 +1,152 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.SketchPartitionLimits (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: SketchPartitionLimits"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.SketchPartitionLimits" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.SketchPartitionLimits</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<h2>Uses of <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h2> +<div class="caption"><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../../kll/KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This variation of the KllSketch implements generic data types.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<h2>Uses of <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h2> +<div class="caption"><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../quantiles/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items, + described in section 3.2 of the journal version of the paper "Mergeable Summaries" + by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Subinterfaces of <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Interface</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The Sorted View for quantiles of generic type.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +</div> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that implement <a href="../SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ItemsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SortedView.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SortedView.html new file mode 100644 index 000000000..077207375 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SortedView.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.quantilescommon.SortedView (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, interface: SortedView"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SortedView.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.quantilescommon.SortedView" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.SortedView</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Subinterfaces of <a href="../SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Interface</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../DoublesSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The Sorted View for quantile sketches of primitive type double.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../FloatsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Sorted View for quantiles of primitive type float.</div> +</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The Sorted View for quantiles of generic type.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../LongsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The Sorted View for quantile sketches of primitive type long.</div> +</div> +</div> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that implement <a href="../SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../DoublesSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../FloatsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ItemsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../LongsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The SortedView of the KllLongsSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SortedViewIterator.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SortedViewIterator.html new file mode 100644 index 000000000..953cbdeac --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/class-use/SortedViewIterator.html @@ -0,0 +1,118 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.quantilescommon.SortedViewIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon, class: SortedViewIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.quantilescommon.SortedViewIterator" class="title">Uses of Class<br>org.apache.datasketches.quantilescommon.SortedViewIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<h2>Uses of <a href="../SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h2> +<div class="caption"><span>Subclasses of <a href="../SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../DoublesSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over quantile sketches of primitive type <i>double</i>.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../FloatsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over quantile sketches of primitive type <i>float</i>.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../GenericSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><T></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over quantile sketches of generic type.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../LongsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over quantile sketches of primitive type <i>long</i>.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a> that return <a href="../SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SortedView.</span><code><a href="../SortedView.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an iterator for this Sorted View.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/package-summary.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/package-summary.html new file mode 100644 index 000000000..24a5c0987 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/package-summary.html @@ -0,0 +1,272 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.quantilescommon (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.quantilescommon"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.quantilescommon" class="title">Package org.apache.datasketches.quantilescommon</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.quantilescommon</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Contains common equality binary search algorithms.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">The Sorted View for quantile sketches of primitive type double.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoublesSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over quantile sketches of primitive type <i>double</i>.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">The Sorted View for quantiles of primitive type float.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="FloatsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over quantile sketches of primitive type <i>float</i>.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GenericInequalitySearch.html" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="GenericInequalitySearch.Inequality.html" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">The enumerator of inequalities</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">The Sorted View for quantiles of generic type.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over quantile sketches of generic type.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IncludeMinMax.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This class reinserts the min and max values into the sorted view arrays as required.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IncludeMinMax.DoublesPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IncludeMinMax.FloatsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IncludeMinMax.ItemsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IncludeMinMax.LongsPair.html" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="InequalitySearch.html" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KolmogorovSmirnov.html" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Kolmogorov-Smirnov Test + See <a href="https://en.wikipedia.org/wiki/Kolmogorov-Smirnov_test">Kolmogorov–Smirnov Test</a></div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LongsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The SortedView of the KllLongsSketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">The Sorted View for quantile sketches of primitive type long.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LongsSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over quantile sketches of primitive type <i>long</i>.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">The quantiles sketch iterator for generic types.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">The Quantiles API for item type <i>long</i>.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">The quantiles sketch iterator for primitive type long.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Utilities for the quantiles sketches.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">This defines the methods required to compute the partition limits.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">This is the base interface for the Sorted View interface hierarchy and defines the methods that are type independent.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This is the base interface for the SortedViewIterator hierarchy used with a SortedView obtained + from a quantile-type sketch.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/package-tree.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/package-tree.html new file mode 100644 index 000000000..4b7eeef6c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/package-tree.html @@ -0,0 +1,154 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.quantilescommon Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.quantilescommon"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.quantilescommon</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="BinarySearch.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="DoublesSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a> (implements org.apache.datasketches.quantilescommon.<a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="FloatsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a> (implements org.apache.datasketches.quantilescommon.<a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="GenericInequalitySearch.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="GenericPartitionBoundaries.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="IncludeMinMax.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="IncludeMinMax.DoublesPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="IncludeMinMax.FloatsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="IncludeMinMax.ItemsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="IncludeMinMax.LongsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="ItemsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><T> (implements org.apache.datasketches.quantilescommon.<a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="KolmogorovSmirnov.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="LongsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a> (implements org.apache.datasketches.quantilescommon.<a href="LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesUtil.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="DoublesSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="FloatsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="GenericSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="LongsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>, org.apache.datasketches.quantilescommon.<a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a>, org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>)</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesDoublesAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesFloatsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesLongsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesDoublesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesFloatsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesGenericSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesLongsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a>)</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="SortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">SortedView</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="DoublesSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="FloatsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="LongsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="GenericInequalitySearch.Inequality.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="InequalitySearch.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="QuantileSearchCriteria.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/quantilescommon/package-use.html b/docs/7.0.X/org/apache/datasketches/quantilescommon/package-use.html new file mode 100644 index 000000000..5c9fcfb83 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/quantilescommon/package-use.html @@ -0,0 +1,435 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.quantilescommon (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.quantilescommon"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.quantilescommon" class="title">Uses of Package<br>org.apache.datasketches.quantilescommon</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, + and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.partitions">org.apache.datasketches.partitions</a></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass + analysis of the distribution of a stream of quantiles.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and + <i>req</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.kll"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.quantilescommon</a> used by <a href="../kll/package-summary.html">org.apache.datasketches.kll</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/DoublesSketchSortedView.html#org.apache.datasketches.kll">DoublesSketchSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/FloatsSketchSortedView.html#org.apache.datasketches.kll">FloatsSketchSortedView</a></div> +<div class="col-last odd-row-color"> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/GenericPartitionBoundaries.html#org.apache.datasketches.kll">GenericPartitionBoundaries</a></div> +<div class="col-last even-row-color"> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ItemsSketchSortedView.html#org.apache.datasketches.kll">ItemsSketchSortedView</a></div> +<div class="col-last odd-row-color"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/LongsSketchSortedView.html#org.apache.datasketches.kll">LongsSketchSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView of the KllLongsSketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/PartitioningFeature.html#org.apache.datasketches.kll">PartitioningFeature</a></div> +<div class="col-last odd-row-color"> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesAPI.html#org.apache.datasketches.kll">QuantilesAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesDoublesAPI.html#org.apache.datasketches.kll">QuantilesDoublesAPI</a></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesDoublesSketchIterator.html#org.apache.datasketches.kll">QuantilesDoublesSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantileSearchCriteria.html#org.apache.datasketches.kll">QuantileSearchCriteria</a></div> +<div class="col-last odd-row-color"> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesFloatsAPI.html#org.apache.datasketches.kll">QuantilesFloatsAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesFloatsSketchIterator.html#org.apache.datasketches.kll">QuantilesFloatsSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesGenericAPI.html#org.apache.datasketches.kll">QuantilesGenericAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesGenericSketchIterator.html#org.apache.datasketches.kll">QuantilesGenericSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for generic types.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesLongsAPI.html#org.apache.datasketches.kll">QuantilesLongsAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>long</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesLongsSketchIterator.html#org.apache.datasketches.kll">QuantilesLongsSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for primitive type long.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesSketchIterator.html#org.apache.datasketches.kll">QuantilesSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SketchPartitionLimits.html#org.apache.datasketches.kll">SketchPartitionLimits</a></div> +<div class="col-last odd-row-color"> +<div class="block">This defines the methods required to compute the partition limits.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.partitions"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.quantilescommon</a> used by <a href="../partitions/package-summary.html">org.apache.datasketches.partitions</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/GenericPartitionBoundaries.html#org.apache.datasketches.partitions">GenericPartitionBoundaries</a></div> +<div class="col-last even-row-color"> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/PartitioningFeature.html#org.apache.datasketches.partitions">PartitioningFeature</a></div> +<div class="col-last odd-row-color"> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantileSearchCriteria.html#org.apache.datasketches.partitions">QuantileSearchCriteria</a></div> +<div class="col-last even-row-color"> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesGenericAPI.html#org.apache.datasketches.partitions">QuantilesGenericAPI</a></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantiles"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.quantilescommon</a> used by <a href="../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/DoublesSketchSortedView.html#org.apache.datasketches.quantiles">DoublesSketchSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/GenericPartitionBoundaries.html#org.apache.datasketches.quantiles">GenericPartitionBoundaries</a></div> +<div class="col-last odd-row-color"> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ItemsSketchSortedView.html#org.apache.datasketches.quantiles">ItemsSketchSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView for the KllItemsSketch and the classic ItemsSketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/PartitioningFeature.html#org.apache.datasketches.quantiles">PartitioningFeature</a></div> +<div class="col-last odd-row-color"> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesAPI.html#org.apache.datasketches.quantiles">QuantilesAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesDoublesAPI.html#org.apache.datasketches.quantiles">QuantilesDoublesAPI</a></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesDoublesSketchIterator.html#org.apache.datasketches.quantiles">QuantilesDoublesSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantileSearchCriteria.html#org.apache.datasketches.quantiles">QuantileSearchCriteria</a></div> +<div class="col-last odd-row-color"> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesGenericAPI.html#org.apache.datasketches.quantiles">QuantilesGenericAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesGenericSketchIterator.html#org.apache.datasketches.quantiles">QuantilesGenericSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for generic types.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesSketchIterator.html#org.apache.datasketches.quantiles">QuantilesSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SketchPartitionLimits.html#org.apache.datasketches.quantiles">SketchPartitionLimits</a></div> +<div class="col-last odd-row-color"> +<div class="block">This defines the methods required to compute the partition limits.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.quantilescommon"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.quantilescommon</a> used by <a href="package-summary.html">org.apache.datasketches.quantilescommon</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/DoublesSortedView.html#org.apache.datasketches.quantilescommon">DoublesSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The Sorted View for quantile sketches of primitive type double.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/DoublesSortedViewIterator.html#org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over quantile sketches of primitive type <i>double</i>.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/FloatsSortedView.html#org.apache.datasketches.quantilescommon">FloatsSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The Sorted View for quantiles of primitive type float.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/FloatsSortedViewIterator.html#org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over quantile sketches of primitive type <i>float</i>.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/GenericInequalitySearch.Inequality.html#org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></div> +<div class="col-last even-row-color"> +<div class="block">The enumerator of inequalities</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/GenericPartitionBoundaries.html#org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a></div> +<div class="col-last odd-row-color"> +<div class="block">This defines the returned results of the getParitionBoundaries() function and + includes the basic methods needed to construct actual partitions.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/GenericSortedView.html#org.apache.datasketches.quantilescommon">GenericSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The Sorted View for quantiles of generic type.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/GenericSortedViewIterator.html#org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">Iterator over quantile sketches of generic type.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/IncludeMinMax.DoublesPair.html#org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></div> +<div class="col-last even-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/IncludeMinMax.FloatsPair.html#org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></div> +<div class="col-last odd-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first even-row-color"><a href="class-use/IncludeMinMax.ItemsPair.html#org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a></div> +<div class="col-last even-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/IncludeMinMax.LongsPair.html#org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></div> +<div class="col-last odd-row-color"> +<div class="block">A simple structure to hold a pair of arrays</div> +</div> +<div class="col-first even-row-color"><a href="class-use/InequalitySearch.html#org.apache.datasketches.quantilescommon">InequalitySearch</a></div> +<div class="col-last even-row-color"> +<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria + for ordered arrays of values that may include duplicate values.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/LongsSortedView.html#org.apache.datasketches.quantilescommon">LongsSortedView</a></div> +<div class="col-last odd-row-color"> +<div class="block">The Sorted View for quantile sketches of primitive type long.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/LongsSortedViewIterator.html#org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over quantile sketches of primitive type <i>long</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/PartitioningFeature.html#org.apache.datasketches.quantilescommon">PartitioningFeature</a></div> +<div class="col-last odd-row-color"> +<div class="block">This enables the special functions for performing efficient partitioning of massive data.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesAPI.html#org.apache.datasketches.quantilescommon">QuantilesAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesDoublesAPI.html#org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>double</i>.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesDoublesSketchIterator.html#org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles sketch iterator for primitive type double.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantileSearchCriteria.html#org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></div> +<div class="col-last odd-row-color"> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesFloatsAPI.html#org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesFloatsSketchIterator.html#org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesGenericAPI.html#org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>generic</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesGenericSketchIterator.html#org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for generic types.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesLongsAPI.html#org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></div> +<div class="col-last even-row-color"> +<div class="block">The Quantiles API for item type <i>long</i>.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesLongsSketchIterator.html#org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">The quantiles sketch iterator for primitive type long.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesSketchIterator.html#org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SketchPartitionLimits.html#org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></div> +<div class="col-last odd-row-color"> +<div class="block">This defines the methods required to compute the partition limits.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SortedView.html#org.apache.datasketches.quantilescommon">SortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">This is the base interface for the Sorted View interface hierarchy and defines the methods that are type independent.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SortedViewIterator.html#org.apache.datasketches.quantilescommon">SortedViewIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is the base interface for the SortedViewIterator hierarchy used with a SortedView obtained + from a quantile-type sketch.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.quantilescommon</a> used by <a href="../req/package-summary.html">org.apache.datasketches.req</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/FloatsSketchSortedView.html#org.apache.datasketches.req">FloatsSketchSortedView</a></div> +<div class="col-last even-row-color"> +<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesAPI.html#org.apache.datasketches.req">QuantilesAPI</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the + approximate distribution of items from a very large stream in a single pass, requiring only + that the items are comparable.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantileSearchCriteria.html#org.apache.datasketches.req">QuantileSearchCriteria</a></div> +<div class="col-last even-row-color"> +<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesFloatsAPI.html#org.apache.datasketches.req">QuantilesFloatsAPI</a></div> +<div class="col-last odd-row-color"> +<div class="block">The Quantiles API for item type <i>float</i>.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/QuantilesFloatsSketchIterator.html#org.apache.datasketches.req">QuantilesFloatsSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">The quantiles sketch iterator for primitive type float.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/QuantilesSketchIterator.html#org.apache.datasketches.req">QuantilesSketchIterator</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the + non-ordered quantiles retained by a sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/ReqDebug.html b/docs/7.0.X/org/apache/datasketches/req/ReqDebug.html new file mode 100644 index 000000000..a399e33d0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/ReqDebug.html @@ -0,0 +1,283 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReqDebug (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.req, interface: ReqDebug"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReqDebug.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.req</a></div> +<h1 title="Interface ReqDebug" class="title">Interface ReqDebug</h1> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ReqDebug</span></div> +<div class="block">The signaling interface that allows comprehensive analysis of the ReqSketch and ReqCompactor + while eliminating code clutter in the main classes. The implementation of this interface can be + found in the test tree.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitAdjSecSizeNumSec(byte)" class="member-name-link">emitAdjSecSizeNumSec</a><wbr>(byte lgWeight)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit adjusting section size and number of sections.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitAllHorizList()" class="member-name-link">emitAllHorizList</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit all horizontal lists</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitCompactingStart(byte)" class="member-name-link">emitCompactingStart</a><wbr>(byte lgWeight)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit Compaction Start.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitCompactionDetail(int,int,int,int,boolean)" class="member-name-link">emitCompactionDetail</a><wbr>(int compactionStart, + int compactionEnd, + int secsToCompact, + int promoteLen, + boolean coin)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit Compaction details.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitCompactionDone(byte)" class="member-name-link">emitCompactionDone</a><wbr>(byte lgWeight)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit compaction done and number of compactions so far.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitCompressDone()" class="member-name-link">emitCompressDone</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit compress done.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitMustAddCompactor()" class="member-name-link">emitMustAddCompactor</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit Must add compactor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitNewCompactor(byte)" class="member-name-link">emitNewCompactor</a><wbr>(byte lgWeight)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit new compactor configuration</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitStart(org.apache.datasketches.req.ReqSketch)" class="member-name-link">emitStart</a><wbr>(<a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> sk)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit the start signal</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emitStartCompress()" class="member-name-link">emitStartCompress</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Emit Start Compress</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="emitStart(org.apache.datasketches.req.ReqSketch)"> +<h3>emitStart</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitStart</span><wbr><span class="parameters">(<a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> sk)</span></div> +<div class="block">Emit the start signal</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sk</code> - the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="emitStartCompress()"> +<h3>emitStartCompress</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitStartCompress</span>()</div> +<div class="block">Emit Start Compress</div> +</section> +</li> +<li> +<section class="detail" id="emitCompressDone()"> +<h3>emitCompressDone</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitCompressDone</span>()</div> +<div class="block">Emit compress done.</div> +</section> +</li> +<li> +<section class="detail" id="emitAllHorizList()"> +<h3>emitAllHorizList</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitAllHorizList</span>()</div> +<div class="block">Emit all horizontal lists</div> +</section> +</li> +<li> +<section class="detail" id="emitMustAddCompactor()"> +<h3>emitMustAddCompactor</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitMustAddCompactor</span>()</div> +<div class="block">Emit Must add compactor</div> +</section> +</li> +<li> +<section class="detail" id="emitCompactingStart(byte)"> +<h3>emitCompactingStart</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitCompactingStart</span><wbr><span class="parameters">(byte lgWeight)</span></div> +<div class="block">Emit Compaction Start.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgWeight</code> - compactor lgWeight or height</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="emitNewCompactor(byte)"> +<h3>emitNewCompactor</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitNewCompactor</span><wbr><span class="parameters">(byte lgWeight)</span></div> +<div class="block">Emit new compactor configuration</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgWeight</code> - the log weight</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="emitAdjSecSizeNumSec(byte)"> +<h3>emitAdjSecSizeNumSec</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitAdjSecSizeNumSec</span><wbr><span class="parameters">(byte lgWeight)</span></div> +<div class="block">Emit adjusting section size and number of sections.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgWeight</code> - the log weight</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="emitCompactionDetail(int,int,int,int,boolean)"> +<h3>emitCompactionDetail</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitCompactionDetail</span><wbr><span class="parameters">(int compactionStart, + int compactionEnd, + int secsToCompact, + int promoteLen, + boolean coin)</span></div> +<div class="block">Emit Compaction details.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>compactionStart</code> - the offset of compaction start</dd> +<dd><code>compactionEnd</code> - the offset of compaction end</dd> +<dd><code>secsToCompact</code> - the number of sections to compact</dd> +<dd><code>promoteLen</code> - the length of the promotion field</dd> +<dd><code>coin</code> - the state of the random coin.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="emitCompactionDone(byte)"> +<h3>emitCompactionDone</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">emitCompactionDone</span><wbr><span class="parameters">(byte lgWeight)</span></div> +<div class="block">Emit compaction done and number of compactions so far.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgWeight</code> - the log weight</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/ReqSketch.html b/docs/7.0.X/org/apache/datasketches/req/ReqSketch.html new file mode 100644 index 000000000..50f484893 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/ReqSketch.html @@ -0,0 +1,1094 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReqSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.req, class: ReqSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReqSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.req</a></div> +<h1 title="Class ReqSketch" class="title">Class ReqSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.req.ReqSketch</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReqSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper + "Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty, + Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝. + + <p>Reference: https://arxiv.org/abs/2004.01668</p> + + <p>This implementation differs from the algorithm described in the paper in the following:</p> + + <ul> + <li>The algorithm requires no upper bound on the stream length. + Instead, each relative-compactor counts the number of compaction operations performed + so far (via variable state). Initially, the relative-compactor starts with INIT_NUMBER_OF_SECTIONS. + Each time the number of compactions (variable state) exceeds 2^{numSections - 1}, we double + numSections. Note that after merging the sketch with another one variable state may not correspond + to the number of compactions performed at a particular level, however, since the state variable + never exceeds the number of compactions, the guarantees of the sketch remain valid.</li> + + <li>The size of each section (variable k and sectionSize in the code and parameter k in + the paper) is initialized with a number set by the user via variable k. + When the number of sections doubles, we decrease sectionSize by a factor of sqrt(2). + This is applied at each level separately. Thus, when we double the number of sections, the + nominal compactor size increases by a factor of approx. sqrt(2) (+/- rounding).</li> + + <li>The merge operation here does not perform "special compactions", which are used in the paper + to allow for a tight mathematical analysis of the sketch.</li> + </ul> + + <p>This implementation provides a number of capabilities not discussed in the paper or provided + in the Python prototype.</p> + + <ul><li>The Python prototype only implemented high accuracy for low ranks. This implementation + provides the user with the ability to choose either high rank accuracy or low rank accuracy at + the time of sketch construction.</li> + <li>The Python prototype only implemented a comparison criterion of "INCLUSIVE". This implementation + allows the user to switch back and forth between the "INCLUSIVE" criterion and the "EXCLUSIVE" criterion.</li> + <li>This implementation provides extensive debug visibility into the operation of the sketch with + two levels of detail output. This is not only useful for debugging, but is a powerful tool to + help users understand how the sketch works.</li> + </ul></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Edo Liberty, Pavel Vesely, Lee Rhodes</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesAPI">Fields inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> +<code><a href="../quantilescommon/QuantilesAPI.html#EMPTY_MSG">EMPTY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#MEM_REQ_SVR_NULL_MSG">MEM_REQ_SVR_NULL_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#NOT_SINGLE_ITEM_MSG">NOT_SINGLE_ITEM_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#SELF_MERGE_MSG">SELF_MERGE_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#TGT_IS_READ_ONLY_MSG">TGT_IS_READ_ONLY_MSG</a>, <a href="../quantilescommon/QuantilesAPI.html#UNSUPPORTED_MSG">UNSUPPORTED_MSG</a></code></div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a new ReqSketchBuilder</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getCDF</a><wbr>(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHighRankAccuracyMode()" class="member-name-link">getHighRankAccuracyMode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">If true, the high ranks are prioritized for better accuracy.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxItem()" class="member-name-link">getMaxItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum item of the stream.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinItem()" class="member-name-link">getMinItem</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the minimum item of the stream.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNormalizedRankError(boolean)" class="member-name-link">getNormalizedRankError</a><wbr>(boolean pmf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumRetained()" class="member-name-link">getNumRetained</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getPMF</a><wbr>(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantile</a><wbr>(double normRank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileLowerBound(double,int)" class="member-name-link">getQuantileLowerBound</a><wbr>(double rank, + int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an approximate lower bound of the quantile associated with the given rank.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getQuantiles</a><wbr>(double[] normRanks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantileUpperBound(double,int)" class="member-name-link">getQuantileUpperBound</a><wbr>(double rank, + int numStdDev)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an approximate upper bound of the quantile associated with the given rank.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRank</a><wbr>(float quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double)" class="member-name-link">getRankLowerBound</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankLowerBound(double,int)" class="member-name-link">getRankLowerBound</a><wbr>(double rank, + int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an approximate lower bound rank of the given normalized rank.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)" class="member-name-link">getRanks</a><wbr>(float[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double)" class="member-name-link">getRankUpperBound</a><wbr>(double rank)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRankUpperBound(double,int)" class="member-name-link">getRankUpperBound</a><wbr>(double rank, + int numStdDev)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an approximate upper bound rank of the given rank.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRSE(int,double,boolean,long)" class="member-name-link">getRSE</a><wbr>(int k, + double rank, + boolean hra, + long totalN)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an a priori estimate of relative standard error (RSE, expressed as a number in [0,1]).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerializedSizeBytes()" class="member-name-link">getSerializedSizeBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedView()" class="member-name-link">getSortedView</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the sorted view of this sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an ReqSketch on the heap from a Memory image of the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDirect()" class="member-name-link">isDirect</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is empty.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is in estimation mode.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is read only.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.req.ReqSketch)" class="member-name-link">merge</a><wbr>(<a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> other)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Merge other sketch into this one.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a summary of the key parameters of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(float)" class="member-name-link">update</a><wbr>(float item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#viewCompactorDetail(java.lang.String,boolean)" class="member-name-link">viewCompactorDetail</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fmt, + boolean allData)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">A detailed, human readable view of the sketch compactors and their data.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.quantilescommon.QuantilesFloatsAPI">Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></h3> +<code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float)">getRank</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D)">getRanks</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="builder()"> +<h3>builder</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></span> <span class="element-name">builder</span>()</div> +<div class="block">Returns a new ReqSketchBuilder</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a new ReqSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns an ReqSketch on the heap from a Memory image of the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - The Memory object holding a valid image of an ReqSketch</dd> +<dt>Returns:</dt> +<dd>an ReqSketch on the heap from a Memory image of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getK()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the user configured parameter k, which controls the accuracy of the sketch + and its memory space usage.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream + as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(false) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> overlapping intervals. + <blockquote> + <p>The start of each interval is below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and the end of the interval + is the rank or cumulative probability corresponding to the split point.</p> + + <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch + and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i> + rank or probability in the returned array is always 1.0.</p> + + <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p> + + <ul> + <li>INCLUSIVE, the resulting cumulative probability will include that item.</li> + <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getHighRankAccuracyMode()"> +<h3>getHighRankAccuracyMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getHighRankAccuracyMode</span>()</div> +<div class="block">If true, the high ranks are prioritized for better accuracy. Otherwise + the low ranks are prioritized for better accuracy. This state is chosen during sketch + construction.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the high ranks accuracy state.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxItem()"> +<h3>getMaxItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getMaxItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMaxItem()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns the maximum item of the stream. This is provided for convenience, but may be different from the largest + item retained by the sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinItem()"> +<h3>getMinItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getMinItem</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMinItem()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns the minimum item of the stream. This is provided for convenience, but is distinct from the smallest + item retained by the sketch algorithm.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMinItem()">getMinItem</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the minimum item of the stream</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getN()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the length of the input stream offered to the sketch..</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the length of the input stream offered to the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNormalizedRankError(boolean)"> +<h3>getNormalizedRankError</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getNormalizedRankError</span><wbr><span class="parameters">(boolean pmf)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNormalizedRankError(boolean)">QuantilesAPI</a></code></span></div> +<div class="block">Gets the approximate rank error of this sketch normalized as a fraction between zero and one. + The epsilon returned is a best fit to 99 percent confidence empirically measured max error + in thousands of trials.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>pmf</code> - if true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +<dt>Returns:</dt> +<dd>if pmf is true, returns the "double-sided" normalized rank error for the getPMF() function. + Otherwise, it is the "single-sided" normalized rank error for all the other queries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(float[] splitPoints, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + as an array of probability masses as doubles on the interval [0.0, 1.0], + given a set of splitPoints. + + <p>The resulting approximations have a probabilistic guarantee that can be obtained from the + getNormalizedRankError(true) function.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items + (of the same type as the input items) + that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals. + <blockquote> + <p>Each interval except for the end intervals starts with a split point and ends with the next split + point in sequence.</p> + + <p>The first interval starts below the lowest item retained by the sketch + corresponding to a zero rank or zero probability, and ends with the first split point</p> + + <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last + item retained by the sketch corresponding to a rank or probability of 1.0. </p> + + <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p> + + <p>If the search criterion is:</p> + + <ul> + <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude + that item.</li> + <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval + will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include + that item.</li> + </ul> + + <p>It is not recommended to include either the minimum or maximum items of the input stream.</p> + </blockquote></dd> +<dd><code>searchCrit</code> - the desired search criteria.</dd> +<dt>Returns:</dt> +<dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double normRank, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>normRank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd> +<dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles ≤ + the quantile directly corresponding to the given rank. + If EXCLUSIVE, he given rank includes all quantiles < + the quantile directly corresponding to the given rank.</dd> +<dt>Returns:</dt> +<dd>the approximate quantile given the normalized rank.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getQuantiles</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float[]</span> <span class="element-name">getQuantiles</span><wbr><span class="parameters">(double[] normRanks, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>normRanks</code> - the given array of normalized ranks, each of which must be + in the interval [0.0,1.0].</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles ≤ + the quantile directly corresponding to each rank.</dd> +<dt>Returns:</dt> +<dd>an array of quantiles corresponding to the given array of normalized ranks.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile confidence interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.95.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the lower bound of the quantile confidence interval in which the quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileLowerBound(double,int)"> +<h3>getQuantileLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantileLowerBound</span><wbr><span class="parameters">(double rank, + int numStdDev)</span></div> +<div class="block">Gets an approximate lower bound of the quantile associated with the given rank.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a number between 0 and 1.0.</dd> +<dd><code>numStdDev</code> - the number of standard deviations. Must be 1, 2, or 3.</dd> +<dt>Returns:</dt> +<dd>an approximate lower bound quantile, if it exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists. + + <p>Although it is possible to estimate the probability that the true quantile + exists within the quantile confidence interval specified by the upper and lower quantile bounds, + it is not possible to guarantee the width of the quantile interval + as an additive or multiplicative percent of the true quantile.</p> + The approximate probability that the true quantile is within the confidence interval + specified by the upper and lower quantile bounds for this sketch is 0.95.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank</dd> +<dt>Returns:</dt> +<dd>the upper bound of the quantile confidence interval in which the true quantile of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantileUpperBound(double,int)"> +<h3>getQuantileUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantileUpperBound</span><wbr><span class="parameters">(double rank, + int numStdDev)</span></div> +<div class="block">Gets an approximate upper bound of the quantile associated with the given rank.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a number between 0 and 1.0.</dd> +<dd><code>numStdDev</code> - the number of standard deviations. Must be 1, 2, or 3.</dd> +<dt>Returns:</dt> +<dd>an approximate upper bound quantile, if it exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(float quantile, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the normalized rank corresponding to the given a quantile.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantile</code> - the given quantile</dd> +<dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd> +<dt>Returns:</dt> +<dd>the normalized rank corresponding to the given quantile.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.95.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the lower bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankLowerBound(double,int)"> +<h3>getRankLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankLowerBound</span><wbr><span class="parameters">(double rank, + int numStdDev)</span></div> +<div class="block">Gets an approximate lower bound rank of the given normalized rank.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank, a number between 0 and 1.0.</dd> +<dd><code>numStdDev</code> - the number of standard deviations. Must be 1, 2, or 3.</dd> +<dt>Returns:</dt> +<dd>an approximate lower bound rank.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRanks(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> +<h3>getRanks</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getRanks</span><wbr><span class="parameters">(float[] quantiles, + <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given + search criterion.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>quantiles</code> - the given array of quantiles</dd> +<dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd> +<dt>Returns:</dt> +<dd>an array of normalized ranks corresponding to the given array of quantiles.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum class in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the + given rank exists. + The approximate probability that the true rank is within the confidence interval + specified by the upper and lower rank bounds for this sketch is 0.95.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given normalized rank.</dd> +<dt>Returns:</dt> +<dd>the upper bound of the rank confidence interval in which the true rank of the + given rank exists.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRankUpperBound(double,int)"> +<h3>getRankUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRankUpperBound</span><wbr><span class="parameters">(double rank, + int numStdDev)</span></div> +<div class="block">Gets an approximate upper bound rank of the given rank.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - the given rank, a number between 0 and 1.0.</dd> +<dd><code>numStdDev</code> - the number of standard deviations. Must be 1, 2, or 3.</dd> +<dt>Returns:</dt> +<dd>an approximate upper bound rank.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumRetained()"> +<h3>getNumRetained</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumRetained</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">QuantilesAPI</a></code></span></div> +<div class="block">Gets the number of quantiles retained by the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the number of quantiles retained by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes()"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSerializedSizeBytes()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns the current number of bytes this Sketch would require if serialized.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSerializedSizeBytes()">getSerializedSizeBytes</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the number of bytes this sketch would require if serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is empty.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is in estimation mode.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#iterator()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the iterator for this sketch, which is not sorted.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the iterator for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.req.ReqSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> other)</span></div> +<div class="block">Merge other sketch into this one. The other sketch is not modified.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - sketch to be merged into this one.</dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state. + If the sketch is <i>read only</i> this does nothing. + + <p>The parameter <i>k</i> will not change.</p> + + <p>The parameters k, highRankAccuracy, and reqDebug will not change.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#toByteArray()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Returns a byte array representation of this sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#toString()">QuantilesAPI</a></code></span></div> +<div class="block">Returns a summary of the key parameters of the sketch.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>a summary of the key parameters of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(float)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(float item)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#update(float)">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Updates this sketch with the given item.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#update(float)">update</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Parameters:</dt> +<dd><code>item</code> - from a stream of quantiles. NaNs are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="viewCompactorDetail(java.lang.String,boolean)"> +<h3>viewCompactorDetail</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">viewCompactorDetail</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fmt, + boolean allData)</span></div> +<div class="block">A detailed, human readable view of the sketch compactors and their data. + Each compactor string is prepended by the compactor lgWeight, the current number of retained + quantiles of the compactor and the current nominal capacity of the compactor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>fmt</code> - the format string for the quantiles; example: "%4.0f".</dd> +<dd><code>allData</code> - all the retained quantiles for the sketch will be output by + compactor level. Otherwise, just a summary will be output.</dd> +<dt>Returns:</dt> +<dd>a detailed view of the compactors and their data</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSortedView()"> +<h3>getSortedView</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></span> <span class="element-name">getSortedView</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSortedView()">QuantilesFloatsAPI</a></code></span></div> +<div class="block">Gets the sorted view of this sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> +<dt>Returns:</dt> +<dd>the sorted view of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRSE(int,double,boolean,long)"> +<h3>getRSE</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getRSE</span><wbr><span class="parameters">(int k, + double rank, + boolean hra, + long totalN)</span></div> +<div class="block">Returns an a priori estimate of relative standard error (RSE, expressed as a number in [0,1]). + Derived from Lemma 12 in https://arxiv.org/abs/2004.01668v2, but the constant factors were + adjusted based on empirical measurements.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - the given size of k</dd> +<dd><code>rank</code> - the given normalized rank, a number in [0,1].</dd> +<dd><code>hra</code> - if true High Rank Accuracy mode is being selected, otherwise, Low Rank Accuracy.</dd> +<dd><code>totalN</code> - an estimate of the total number of items submitted to the sketch.</dd> +<dt>Returns:</dt> +<dd>an a priori estimate of relative standard error (RSE, expressed as a number in [0,1]).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isDirect()"> +<h3>isDirect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDirect</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is off-heap (a.k.a., Direct or Native memory).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isReadOnly()"> +<h3>isReadOnly</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">QuantilesAPI</a></code></span></div> +<div class="block">Returns true if this sketch is read only.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is read only.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/ReqSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/req/ReqSketchBuilder.html new file mode 100644 index 000000000..3e56d4dd6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/ReqSketchBuilder.html @@ -0,0 +1,293 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReqSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.req, class: ReqSketchBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReqSketchBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.req</a></div> +<h1 title="Class ReqSketchBuilder" class="title">Class ReqSketchBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.req.ReqSketchBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ReqSketchBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">For building a new ReqSketch</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ReqSketchBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor for the ReqSketchBuilder.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a new ReqSketch with the current configuration of the builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHighRankAccuracy()" class="member-name-link">getHighRankAccuracy</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the builder configured High Rank Accuracy.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the builder configured k.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReqDebug()" class="member-name-link">getReqDebug</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the builder configured ReqDebug</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHighRankAccuracy(boolean)" class="member-name-link">setHighRankAccuracy</a><wbr>(boolean hra)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This sets the parameter highRankAccuracy.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setK(int)" class="member-name-link">setK</a><wbr>(int k)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This sets the parameter k.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReqDebug(org.apache.datasketches.req.ReqDebug)" class="member-name-link">setReqDebug</a><wbr>(<a href="ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a> reqDebug)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This sets the parameter reqDebug.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ReqSketchBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReqSketchBuilder</span>()</div> +<div class="block">Constructor for the ReqSketchBuilder.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="build()"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></span> <span class="element-name">build</span>()</div> +<div class="block">Returns a new ReqSketch with the current configuration of the builder.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a new ReqSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getHighRankAccuracy()"> +<h3>getHighRankAccuracy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getHighRankAccuracy</span>()</div> +<div class="block">Gets the builder configured High Rank Accuracy.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the builder configured High Rank Accuracy.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block">Gets the builder configured k.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the builder configured k.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getReqDebug()"> +<h3>getReqDebug</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></span> <span class="element-name">getReqDebug</span>()</div> +<div class="block">Gets the builder configured ReqDebug</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the builder configured ReqDebug, or null.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setHighRankAccuracy(boolean)"> +<h3>setHighRankAccuracy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></span> <span class="element-name">setHighRankAccuracy</span><wbr><span class="parameters">(boolean hra)</span></div> +<div class="block">This sets the parameter highRankAccuracy.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hra</code> - See <i>ReqSketch#ReqSketch(int, boolean, ReqDebug)</i></dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setK(int)"> +<h3>setK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></span> <span class="element-name">setK</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">This sets the parameter k.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - See <i>ReqSketch#ReqSketch(int, boolean, ReqDebug)</i></dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setReqDebug(org.apache.datasketches.req.ReqDebug)"> +<h3>setReqDebug</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></span> <span class="element-name">setReqDebug</span><wbr><span class="parameters">(<a href="ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a> reqDebug)</span></div> +<div class="block">This sets the parameter reqDebug.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>reqDebug</code> - See <i>ReqSketch#ReqSketch(int, boolean, ReqDebug)</i></dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/ReqSketchIterator.html b/docs/7.0.X/org/apache/datasketches/req/ReqSketchIterator.html new file mode 100644 index 000000000..77332d46b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/ReqSketchIterator.html @@ -0,0 +1,201 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReqSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.req, class: ReqSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReqSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.req</a></div> +<h1 title="Class ReqSketchIterator" class="title">Class ReqSketchIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.req.ReqSketchIterator</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code>, <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReqSketchIterator</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></span></div> +<div class="block">Iterator over all retained items of the ReqSketch. The order is not defined.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile()" class="member-name-link">getQuantile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the float quantile at the current index.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWeight()" class="member-name-link">getWeight</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the natural weight at the current index.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Advances the index and checks if it is valid.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getQuantile()"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getQuantile</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html#getQuantile()">QuantilesFloatsSketchIterator</a></code></span></div> +<div class="block">Gets the float quantile at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html#getQuantile()">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the float quantile at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getWeight()"> +<h3>getWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getWeight</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Gets the natural weight at the current index. + + <p>Don't call this before calling next() for the first time + or after getting false from next().</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#getWeight()">getWeight</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>the natural weight at the current index.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">QuantilesSketchIterator</a></code></span></div> +<div class="block">Advances the index and checks if it is valid. + The state of this iterator is undefined before the first call of this method.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../quantilescommon/QuantilesSketchIterator.html#next()">next</a></code> in interface <code><a href="../quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></code></dd> +<dt>Returns:</dt> +<dd>true if the next index is valid.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/class-use/ReqDebug.html b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqDebug.html new file mode 100644 index 000000000..80570133a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqDebug.html @@ -0,0 +1,102 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.req.ReqDebug (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.req, interface: ReqDebug"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.req.ReqDebug" class="title">Uses of Interface<br>org.apache.datasketches.req.ReqDebug</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a> in <a href="../package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.req</a> that return <a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketchBuilder.</span><code><a href="../ReqSketchBuilder.html#getReqDebug()" class="member-name-link">getReqDebug</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the builder configured ReqDebug</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.req</a> with parameters of type <a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketchBuilder.</span><code><a href="../ReqSketchBuilder.html#setReqDebug(org.apache.datasketches.req.ReqDebug)" class="member-name-link">setReqDebug</a><wbr>(<a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a> reqDebug)</code></div> +<div class="col-last even-row-color"> +<div class="block">This sets the parameter reqDebug.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketch.html b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketch.html new file mode 100644 index 000000000..156a6d659 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketch.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.req.ReqSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.req, class: ReqSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReqSketch.html" title="class in org.apache.datasketches.req">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.req.ReqSketch" class="title">Uses of Class<br>org.apache.datasketches.req.ReqSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> in <a href="../package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.req</a> that return <a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketchBuilder.</span><code><a href="../ReqSketchBuilder.html#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a new ReqSketch with the current configuration of the builder.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../ReqSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an ReqSketch on the heap from a Memory image of the sketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../ReqSketch.html#merge(org.apache.datasketches.req.ReqSketch)" class="member-name-link">merge</a><wbr>(<a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> other)</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.req</a> with parameters of type <a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqDebug.</span><code><a href="../ReqDebug.html#emitStart(org.apache.datasketches.req.ReqSketch)" class="member-name-link">emitStart</a><wbr>(<a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> sk)</code></div> +<div class="col-last even-row-color"> +<div class="block">Emit the start signal</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../ReqSketch.html#merge(org.apache.datasketches.req.ReqSketch)" class="member-name-link">merge</a><wbr>(<a href="../ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a> other)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketchBuilder.html new file mode 100644 index 000000000..262d311d2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketchBuilder.html @@ -0,0 +1,106 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.req.ReqSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.req, class: ReqSketchBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.req.ReqSketchBuilder" class="title">Uses of Class<br>org.apache.datasketches.req.ReqSketchBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<h2>Uses of <a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.req</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.req</a> that return <a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketch.</span><code><a href="../ReqSketch.html#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a new ReqSketchBuilder</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReqSketchBuilder.</span><code><a href="../ReqSketchBuilder.html#setHighRankAccuracy(boolean)" class="member-name-link">setHighRankAccuracy</a><wbr>(boolean hra)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This sets the parameter highRankAccuracy.</div> +</div> +<div class="col-first even-row-color"><code><a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReqSketchBuilder.</span><code><a href="../ReqSketchBuilder.html#setK(int)" class="member-name-link">setK</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">This sets the parameter k.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReqSketchBuilder.</span><code><a href="../ReqSketchBuilder.html#setReqDebug(org.apache.datasketches.req.ReqDebug)" class="member-name-link">setReqDebug</a><wbr>(<a href="../ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a> reqDebug)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This sets the parameter reqDebug.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketchIterator.html b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketchIterator.html new file mode 100644 index 000000000..bc6dda5c0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/class-use/ReqSketchIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.req.ReqSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.req, class: ReqSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReqSketchIterator.html" title="class in org.apache.datasketches.req">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.req.ReqSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.req.ReqSketchIterator</h1> +</div> +No usage of org.apache.datasketches.req.ReqSketchIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/package-summary.html b/docs/7.0.X/org/apache/datasketches/req/package-summary.html new file mode 100644 index 000000000..b62b24859 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/package-summary.html @@ -0,0 +1,134 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.req (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.req"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.req" class="title">Package org.apache.datasketches.req</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.req</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="ReqSketch.html" title="class in org.apache.datasketches.req"><code>ReqSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">The signaling interface that allows comprehensive analysis of the ReqSketch and ReqCompactor + while eliminating code clutter in the main classes.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper + "Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty, + Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">For building a new ReqSketch</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over all retained items of the ReqSketch.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/package-tree.html b/docs/7.0.X/org/apache/datasketches/req/package-tree.html new file mode 100644 index 000000000..3b0e27935 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/package-tree.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.req Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.req"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.req</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.req.<a href="ReqSketch.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketch</a></li> +<li class="circle">org.apache.datasketches.req.<a href="ReqSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></li> +<li class="circle">org.apache.datasketches.req.<a href="ReqSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a>)</li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.req.<a href="ReqDebug.html" class="type-name-link" title="interface in org.apache.datasketches.req">ReqDebug</a></li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/req/package-use.html b/docs/7.0.X/org/apache/datasketches/req/package-use.html new file mode 100644 index 000000000..bb009c21c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/req/package-use.html @@ -0,0 +1,99 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.req (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.req"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.req" class="title">Uses of Package<br>org.apache.datasketches.req</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.req</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.req"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.req</a> used by <a href="package-summary.html">org.apache.datasketches.req</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ReqDebug.html#org.apache.datasketches.req">ReqDebug</a></div> +<div class="col-last even-row-color"> +<div class="block">The signaling interface that allows comprehensive analysis of the ReqSketch and ReqCompactor + while eliminating code clutter in the main classes.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ReqSketch.html#org.apache.datasketches.req">ReqSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper + "Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty, + Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ReqSketchBuilder.html#org.apache.datasketches.req">ReqSketchBuilder</a></div> +<div class="col-last even-row-color"> +<div class="block">For building a new ReqSketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/EbppsItemsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/EbppsItemsSketch.html new file mode 100644 index 000000000..56b285b94 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/EbppsItemsSketch.html @@ -0,0 +1,475 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>EbppsItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: EbppsItemsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/EbppsItemsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class EbppsItemsSketch" class="title">Class EbppsItemsSketch<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.EbppsItemsSketch<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - the item class type</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">EbppsItemsSketch<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">An implementation of an Exact and Bounded Sampling Proportional to Size sketch. + + <p>From: "Exact PPS Sampling with Bounded Sample Size", + B. Hentschel, P. J. Haas, Y. Tian. Information Processing Letters, 2023. + + <p>This sketch samples data from a stream of items proportional to the weight of each item. + The sample guarantees the presence of an item in the result is proportional to that item's + portion of the total weight seen by the sketch, and returns a sample no larger than size k. + + <p>The sample may be smaller than k and the resulting size of the sample potentially includes + a probabilistic component, meaning the resulting sample size is not always constant.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">EbppsItemsSketch</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getC()" class="member-name-link">getC</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the expected number of samples returned upon a call to + getResult().</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCumulativeWeight()" class="member-name-link">getCumulativeWeight</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the cumulative weight of items processed by the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the configured maximum sample size.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of items processed by the sketch, regardless + of item weight.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a copy of the current sample.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">getSerializedSizeBytes</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the size of a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">getSerializedSizeBytes</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the length of a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the sketch is empty.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.sampling.EbppsItemsSketch)" class="member-name-link">merge</a><wbr>(<a href="EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Merges the provided sketch into the current one.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets the sketch to its default, empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Provides a human-readable summary of the sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a> item)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given data item with weight 1.0.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T,double)" class="member-name-link">update</a><wbr>(<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a> item, + double weight)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with the given data item with the given weight.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int)"> +<h3>EbppsItemsSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">EbppsItemsSketch</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Constructor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - The maximum number of samples to retain</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><T></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item this sketch contains</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a Memory representation of a sketch of this class. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a sketch instance of this class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a> item)</span></div> +<div class="block">Updates this sketch with the given data item with weight 1.0.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item from a stream of items</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T,double)"> +<h3 id="update(java.lang.Object,double)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a> item, + double weight)</span></div> +<div class="block">Updates this sketch with the given data item with the given weight.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item from a stream of items</dd> +<dd><code>weight</code> - the weight of the item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.sampling.EbppsItemsSketch)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> other)</span></div> +<div class="block">Merges the provided sketch into the current one.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - the sketch to merge into the current object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>></span> <span class="element-name">getResult</span>()</div> +<div class="block">Returns a copy of the current sample. The exact size may be + probabilistic, differing by at most 1 item.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current sketch sample</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Provides a human-readable summary of the sketch</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>a summary of information in the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block">Returns the configured maximum sample size.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>configured maximum sample size</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Returns the number of items processed by the sketch, regardless + of item weight.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>count of items processed by the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCumulativeWeight()"> +<h3>getCumulativeWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getCumulativeWeight</span>()</div> +<div class="block">Returns the cumulative weight of items processed by the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>cumulative weight of items seen</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getC()"> +<h3>getC</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getC</span>()</div> +<div class="block">Returns the expected number of samples returned upon a call to + getResult(). The number is a floating point value, where the + fractional portion represents the probability of including a + "partial item" from the sample. + + <p>The value C should be no larger than the sketch's configured + value of k, although numerical precision limitations mean it + may exceed k by double precision floating point error margins + in certain cases.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The expected number of samples returned when querying the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block">Returns true if the sketch is empty.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>empty flag</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets the sketch to its default, empty state.</div> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe)</span></div> +<div class="block">Returns the size of a byte array representation of this sketch. May fail for polymorphic item types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>the length of a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializedSizeBytes(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"> +<h3>getSerializedSizeBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSerializedSizeBytes</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Returns the length of a byte array representation of this sketch. Copies contents into an array of the + specified class for serialization to allow for polymorphic types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dd><code>clazz</code> - The class represented by <T></dd> +<dt>Returns:</dt> +<dd>the length of a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe)</span></div> +<div class="block">Returns a byte array representation of this sketch. May fail for polymorphic item types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Returns a byte array representation of this sketch. Copies contents into an array of the + specified class for serialization to allow for polymorphic types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dd><code>clazz</code> - The class represented by <T></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/ReservoirItemsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirItemsSketch.html new file mode 100644 index 000000000..49d1e4c08 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirItemsSketch.html @@ -0,0 +1,455 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReservoirItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: ReservoirItemsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReservoirItemsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class ReservoirItemsSketch" class="title">Class ReservoirItemsSketch<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.ReservoirItemsSketch<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of object held in the reservoir.</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReservoirItemsSketch<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This sketch provides a reservoir sample over an input stream of items. The sketch contains a + uniform random sample of unweighted items from the stream.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> predicate)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the + reservoir.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of items processed from the input stream</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumSamples()" class="member-name-link">getNumSamples</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of items in the reservoir, which may be smaller than the + reservoir capacity.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamples()" class="member-name-link">getSamples</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a copy of the items in the reservoir, or null if empty.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamples(java.lang.Class)" class="member-name-link">getSamples</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a copy of the items in the reservoir as members of Class <em>clazz</em>, or null + if empty.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int k)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a mergeable sampling sketch with up to k samples using the default resize + factor (8).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a mergeable sampling sketch with up to k samples using a specified resize factor.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ReservoirItemsSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ReservoirItemsSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a> item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newInstance(int)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Construct a mergeable sampling sketch with up to k samples using the default resize + factor (8).</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of object held in the reservoir.</dd> +<dt>Parameters:</dt> +<dd><code>k</code> - Maximum size of sampling. Allocated size may be smaller until reservoir fills. + Unlike many sketches in this package, this value does <em>not</em> need to be a + power of 2.</dd> +<dt>Returns:</dt> +<dd>A ReservoirLongsSketch initialized with maximum size k and the default resize factor.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newInstance(int,org.apache.datasketches.common.ResizeFactor)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int k, + <a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</span></div> +<div class="block">Construct a mergeable sampling sketch with up to k samples using a specified resize factor.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of object held in the reservoir.</dd> +<dt>Parameters:</dt> +<dd><code>k</code> - Maximum size of sampling. Allocated size may be smaller until reservoir fills. + Unlike many sketches in this package, this value does <em>not</em> need to be a + power of 2.</dd> +<dd><code>rf</code> - <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> +<dt>Returns:</dt> +<dd>A ReservoirLongsSketch initialized with maximum size k and resize factor rf.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item this sketch contains</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a Memory representation of a sketch of this class. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a sketch instance of this class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the + reservoir. The current number of items in the sketch may be lower.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>k, the maximum number of samples in the reservoir</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Returns the number of items processed from the input stream</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>n, the number of stream items the sketch has seen</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumSamples()"> +<h3>getNumSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumSamples</span>()</div> +<div class="block">Returns the current number of items in the reservoir, which may be smaller than the + reservoir capacity.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of items currently in the reservoir</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a> item)</span></div> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - a unit-weight (equivalently, unweighted) item of the set being sampled from</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</section> +</li> +<li> +<section class="detail" id="getSamples()"> +<h3>getSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>[]</span> <span class="element-name">getSamples</span>()</div> +<div class="block">Returns a copy of the items in the reservoir, or null if empty. The returned array length + may be smaller than the reservoir capacity. + + <p>In order to allocate an array of generic type T, uses the class of the first item in + the array. This method method may throw an <code>ArrayAssignmentException</code> if the + reservoir stores instances of a polymorphic base class.</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>A copy of the reservoir array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamples(java.lang.Class)"> +<h3>getSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>[]</span> <span class="element-name">getSamples</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Returns a copy of the items in the reservoir as members of Class <em>clazz</em>, or null + if empty. The returned array length may be smaller than the reservoir capacity. + + <p>This method allocates an array of class <em>clazz</em>, which must either match or + extend T. This method should be used when objects in the array are all instances of T but + are not necessarily instances of the base class.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>clazz</code> - A class to which the items are cast before returning</dd> +<dt>Returns:</dt> +<dd>A copy of the reservoir array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>A string version of the sketch summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ReservoirItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a ReservoirItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ReservoirItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a ReservoirItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> serDe)</span></div> +<div class="block">Returns a byte array representation of this sketch. May fail for polymorphic item types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Returns a byte array representation of this sketch. Copies contents into an array of the + specified class for serialization to allow for polymorphic types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dd><code>clazz</code> - The class represented by <T></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="estimateSubsetSum(java.util.function.Predicate)"> +<h3>estimateSubsetSum</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></span> <span class="element-name">estimateSubsetSum</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> predicate)</span></div> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate. Provides a lower bound, estimate, and upper bound using a target of 2 standard + deviations. + + <p>This is technically a heuristic method, and tries to err on the conservative side.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>predicate</code> - A predicate to use when identifying items.</dd> +<dt>Returns:</dt> +<dd>A summary object containing the estimate, upper and lower bounds, and the total + sketch weight.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/ReservoirItemsUnion.html b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirItemsUnion.html new file mode 100644 index 000000000..46065d628 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirItemsUnion.html @@ -0,0 +1,364 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReservoirItemsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: ReservoirItemsUnion"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReservoirItemsUnion.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class ReservoirItemsUnion" class="title">Class ReservoirItemsUnion<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.ReservoirItemsUnion<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The specific Java type for this sketch</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReservoirItemsUnion<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Class to union reservoir samples of generic items. + + <p>For efficiency reasons, the unioning process picks one of the two sketches to use as the + base. As a result, we provide only a stateful union. Using the same approach for a merge would + result in unpredictable side effects on the underlying sketches.</p> + + <p>A union object is created with a maximum value of <code>k</code>, represented using the + ReservoirSize class. The unioning process may cause the actual number of samples to fall below + that maximum value, but never to exceed it. The result of a union will be a reservoir where + each item from the global input has a uniform probability of selection, but there are no + claims about higher order statistics. For instance, in general all possible permutations of + the global input are not equally likely.</p> + + <p>If taking the union of two reservoirs of different sizes, the output sample will contain no more + than MIN(k_1, k_2) samples.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxK()" class="member-name-link">getMaxK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum allowed reservoir capacity in this union.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a sketch representing the current state of the union.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int maxK)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this union</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this union.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long,int,java.util.ArrayList)" class="member-name-link">update</a><wbr>(long n, + int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> input)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this union with raw elements of a sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">update</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Union the given Memory image of the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.sampling.ReservoirItemsSketch)" class="member-name-link">update</a><wbr>(<a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> sketchIn)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Union the given sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T)" class="member-name-link">update</a><wbr>(<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a> datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this union with a single item to be added to the union.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newInstance(int)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int maxK)</span></div> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item this sketch contains</dd> +<dt>Parameters:</dt> +<dd><code>maxK</code> - The maximum allowed reservoir capacity for any sketches in the union</dd> +<dt>Returns:</dt> +<dd>A new ReservoirItemsUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Instantiates a Union from Memory</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item this sketch contains</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Memory object containing a serialized union</dd> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>A ReservoirItemsUnion created from the provided Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxK()"> +<h3>getMaxK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxK</span>()</div> +<div class="block">Returns the maximum allowed reservoir capacity in this union. The current reservoir capacity + may be lower.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The maximum allowed reservoir capacity in this union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.sampling.ReservoirItemsSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> sketchIn)</span></div> +<div class="block">Union the given sketch. This method can be repeatedly called. If the given sketch is null it is + interpreted as an empty sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - The incoming sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe)</span></div> +<div class="block">Union the given Memory image of the sketch. + +<p>This method can be repeatedly called. If the given sketch is null it is interpreted as an + empty sketch.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory image of sketch to be merged</dd> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a> datum)</span></div> +<div class="block">Present this union with a single item to be added to the union.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given datum of type T.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long,int,java.util.ArrayList)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long n, + int k, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> input)</span></div> +<div class="block">Present this union with raw elements of a sketch. Useful when operating in a distributed + environment like Pig Latin scripts, where an explicit SerDe may be overly complicated but + keeping raw values is simple. Values are <em>not</em> copied and the input array may be + modified.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>n</code> - Total items seen</dd> +<dd><code>k</code> - Reservoir size</dd> +<dd><code>input</code> - Reservoir samples</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>></span> <span class="element-name">getResult</span>()</div> +<div class="block">Returns a sketch representing the current state of the union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The result of any unions already processed.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe)</span></div> +<div class="block">Returns a byte array representation of this union</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this union</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>A string version of the sketch summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Returns a byte array representation of this union. This method should be used when the array + elements are subclasses of a common base class.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dd><code>clazz</code> - A class to which the items are cast before serialization</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this union</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/ReservoirLongsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirLongsSketch.html new file mode 100644 index 000000000..5a600aa7d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirLongsSketch.html @@ -0,0 +1,388 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReservoirLongsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: ReservoirLongsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReservoirLongsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class ReservoirLongsSketch" class="title">Class ReservoirLongsSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.ReservoirLongsSketch</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReservoirLongsSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This sketch provides a reservoir sample over an input stream of <code>long</code>s. The sketch + contains a uniform random sample of items from the stream.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> predicate)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the reservoir.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of items processed from the input stream</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumSamples()" class="member-name-link">getNumSamples</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of items in the reservoir, which may be smaller than the reservoir + capacity.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamples()" class="member-name-link">getSamples</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a copy of the items in the reservoir.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a sketch instance of this class from the given srcMem, which must be a Memory + representation of this sketch class.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ReservoirLongsSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ReservoirLongsSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long item)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newInstance(int)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - Maximum size of sampling. Allocated size may be smaller until sampling fills. Unlike + many sketches in this package, this value does <em>not</em> need to be a power of 2.</dd> +<dt>Returns:</dt> +<dd>A ReservoirLongsSketch initialized with maximum size k and the default resize factor.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newInstance(int,org.apache.datasketches.common.ResizeFactor)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int k, + <a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</span></div> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - Maximum size of sampling. Allocated size may be smaller until sampling fills. Unlike + many sketches in this package, this value does <em>not</em> need to be a power of 2.</dd> +<dd><code>rf</code> - <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> +<dt>Returns:</dt> +<dd>A ReservoirLongsSketch initialized with maximum size k and ResizeFactor rf.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Returns a sketch instance of this class from the given srcMem, which must be a Memory + representation of this sketch class.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a Memory representation of a sketch of this class. <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a sketch instance of this class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the reservoir. + The current number of items in the sketch may be lower.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>k, the maximum number of samples in the reservoir</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Returns the number of items processed from the input stream</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>n, the number of stream items the sketch has seen</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumSamples()"> +<h3>getNumSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumSamples</span>()</div> +<div class="block">Returns the current number of items in the reservoir, which may be smaller than the reservoir + capacity.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of items currently in the reservoir</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamples()"> +<h3>getSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long[]</span> <span class="element-name">getSamples</span>()</div> +<div class="block">Returns a copy of the items in the reservoir. The returned array length may be smaller than the + reservoir capacity.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>A copy of the reservoir array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long item)</span></div> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - a unit-weight (equivalently, unweighted) item of the set being sampled from</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>A string version of the sketch summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a ReservoirLongsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a ReservoirLongsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a ReservoirLongsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a ReservoirLongsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Returns a byte array representation of this sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="estimateSubsetSum(java.util.function.Predicate)"> +<h3>estimateSubsetSum</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></span> <span class="element-name">estimateSubsetSum</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> predicate)</span></div> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate. Provides a lower bound, estimate, and upper bound using a target of 2 standard + deviations. + + <p>This is technically a heuristic method, and tries to err on the conservative side.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>predicate</code> - A predicate to use when identifying items.</dd> +<dt>Returns:</dt> +<dd>A summary object containing the estimate, upper and lower bounds, and the total + sketch weight.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/ReservoirLongsUnion.html b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirLongsUnion.html new file mode 100644 index 000000000..7043d7be4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/ReservoirLongsUnion.html @@ -0,0 +1,306 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ReservoirLongsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: ReservoirLongsUnion"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ReservoirLongsUnion.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class ReservoirLongsUnion" class="title">Class ReservoirLongsUnion</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.ReservoirLongsUnion</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReservoirLongsUnion</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Class to union reservoir samples of longs. + + <p> + For efficiency reasons, the unioning process picks one of the two sketches to use as the base. As + a result, we provide only a stateful union. Using the same approach for a merge would result in + unpredictable side effects on the underlying sketches. + </p> + + <p> + A union object is created with a maximum value of <code>k</code>, represented using the ReservoirSize + class. The unioning process may cause the actual number of samples to fall below that maximum + value, but never to exceed it. The result of a union will be a reservoir where each item from the + global input has a uniform probability of selection, but there are no claims about higher order + statistics. For instance, in general all possible permutations of the global input are not + equally likely. + </p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxK()" class="member-name-link">getMaxK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the maximum allowed reservoir capacity in this union.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a sketch representing the current state of the union.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int maxK)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this union</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long datum)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this union with a long.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.memory.Memory)" class="member-name-link">update</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Union the given Memory image of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.sampling.ReservoirLongsSketch)" class="member-name-link">update</a><wbr>(<a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a> sketchIn)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Union the given sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newInstance(int)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int maxK)</span></div> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxK</code> - The maximum allowed reservoir capacity for any sketches in the union</dd> +<dt>Returns:</dt> +<dd>A new ReservoirLongsUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Instantiates a Union from Memory</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Memory object containing a serialized union</dd> +<dt>Returns:</dt> +<dd>A ReservoirLongsUnion created from the provided Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxK()"> +<h3>getMaxK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxK</span>()</div> +<div class="block">Returns the maximum allowed reservoir capacity in this union. The current reservoir capacity + may be lower.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The maximum allowed reservoir capacity in this union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.sampling.ReservoirLongsSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a> sketchIn)</span></div> +<div class="block">Union the given sketch. + + <p>This method can be repeatedly called. If the given sketch is null it is interpreted as an empty + sketch.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - The incoming sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.memory.Memory)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Union the given Memory image of the sketch. + + <p> + This method can be repeatedly called. If the given sketch is null it is interpreted as an empty + sketch. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory image of sketch to be merged</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long datum)</span></div> +<div class="block">Present this union with a long.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given long datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Returns a sketch representing the current state of the union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The result of any unions already processed.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>A string version of the sketch summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Returns a byte array representation of this union</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array representation of this union</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/SampleSubsetSummary.html b/docs/7.0.X/org/apache/datasketches/sampling/SampleSubsetSummary.html new file mode 100644 index 000000000..2c3ebbef2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/SampleSubsetSummary.html @@ -0,0 +1,184 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SampleSubsetSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: SampleSubsetSummary"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SampleSubsetSummary.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class SampleSubsetSummary" class="title">Class SampleSubsetSummary</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.SampleSubsetSummary</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SampleSubsetSummary</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A simple object o capture the results of a subset sum query on a sampling sketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound()" class="member-name-link">getLowerBound</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotalSketchWeight()" class="member-name-link">getTotalSketchWeight</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound()" class="member-name-link">getUpperBound</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getLowerBound()"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Lower Bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getTotalSketchWeight()"> +<h3>getTotalSketchWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getTotalSketchWeight</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the total sketch weight</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound()"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Upper Bound</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the unique count estimate</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html new file mode 100644 index 000000000..3df89e684 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html @@ -0,0 +1,166 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>VarOptItemsSamples.VarOptItemsIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: VarOptItemsSamples, class: VarOptItemsIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/VarOptItemsSamples.VarOptItemsIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class VarOptItemsSamples.VarOptItemsIterator" class="title">Class VarOptItemsSamples.VarOptItemsIterator</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.VarOptItemsSamples.VarOptItemsIterator</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><T>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">VarOptItemsSamples.VarOptItemsIterator</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><T>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></span></div> +<div class="block">The standard iterator</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasNext()" class="member-name-link">hasNext</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.util.Iterator">Methods inherited from interface java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#forEachRemaining(java.util.function.Consumer)" title="class or interface in java.util" class="external-link">forEachRemaining</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#remove()" title="class or interface in java.util" class="external-link">remove</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="hasNext()"> +<h3>hasNext</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasNext</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#hasNext()" title="class or interface in java.util" class="external-link">hasNext</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a></span> <span class="element-name">next</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#next()" title="class or interface in java.util" class="external-link">next</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html new file mode 100644 index 000000000..fd5afa6f0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html @@ -0,0 +1,164 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>VarOptItemsSamples.WeightedSample (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: VarOptItemsSamples, class: WeightedSample"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/VarOptItemsSamples.WeightedSample.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class VarOptItemsSamples.WeightedSample" class="title">Class VarOptItemsSamples.WeightedSample</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.VarOptItemsSamples.WeightedSample</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">VarOptItemsSamples.WeightedSample</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">A convenience class to allow easy iterator access to a VarOpt sample.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getItem()" class="member-name-link">getItem</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Accesses the iterator's current object</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWeight()" class="member-name-link">getWeight</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Accesses the iterator's current weight value</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getItem()"> +<h3>getItem</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a></span> <span class="element-name">getItem</span>()</div> +<div class="block">Accesses the iterator's current object</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>An item from the sketch's data sample</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getWeight()"> +<h3>getWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getWeight</span>()</div> +<div class="block">Accesses the iterator's current weight value</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>A weight from the sketch's data sample</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.html b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.html new file mode 100644 index 000000000..c442d102a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSamples.html @@ -0,0 +1,307 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>VarOptItemsSamples (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: VarOptItemsSamples"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/VarOptItemsSamples.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class VarOptItemsSamples" class="title">Class VarOptItemsSamples<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.VarOptItemsSamples<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - an item of type T</dd> +</dl> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><T>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">VarOptItemsSamples<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><T>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></span></div> +<div class="block">This class provides access to the samples contained in a VarOptItemsSketch. It provides two + mechanisms for access: + <ul> + <li>An <code>Iterator</code> over <code>WeightedSample</code> objects which can can be used to + access both the items and weights in the sample, and which avoids copying data from the + sketch.</li> + <li>Getter methods to obtain items or weights as arrays, or individual items. These + methods create a (shallow) copy of data from the sketch on the first call to any get + method.</li> + </ul> + + <p>If using getters with a sketch storing heterogeneous items from a polymorphic base class, you + must call <code>setClass()</code> prior to calling one of the getter methods. This is not + necessary if using the iterator.</p> + + <p>The class also implements <code>Iterable</code> to allow the use of forEach loops for + convenience.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="VarOptItemsSamples.VarOptItemsIterator.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.VarOptItemsIterator</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The standard iterator</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="VarOptItemsSamples.WeightedSample.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A convenience class to allow easy iterator access to a VarOpt sample.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumSamples()" class="member-name-link">getNumSamples</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the length Copies items and weights from the sketch, if necessary, and returns the + length of + any + resulting array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#items()" class="member-name-link">items</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a shallow copy of the array of sample items contained in the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#items(int)" class="member-name-link">items</a><wbr>(int i)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a single item from the samples contained in the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setClass(java.lang.Class)" class="member-name-link">setClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Specifies the class to use when copying the item array from the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#weights()" class="member-name-link">weights</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a copy of the array of weights contained in the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#weights(int)" class="member-name-link">weights</a><wbr>(int i)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a single weight from the samples contained in the sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#spliterator()" title="class or interface in java.lang" class="external-link">spliterator</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></span> <span class="element-name">iterator</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setClass(java.lang.Class)"> +<h3>setClass</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setClass</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Specifies the class to use when copying the item array from the sketch. This method is + required if the sketch stores heterogeneous item types of some base class, for instance a + sketch over <code>Number</code>s.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>clazz</code> - The class to use when creating the item array result</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumSamples()"> +<h3>getNumSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumSamples</span>()</div> +<div class="block">Returns the length Copies items and weights from the sketch, if necessary, and returns the + length of + any + resulting array. The result will be 0 for an empty sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The number of items and weights in the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="items()"> +<h3>items</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>[]</span> <span class="element-name">items</span>()</div> +<div class="block">Returns a shallow copy of the array of sample items contained in the sketch. If this is the + first getter call, copies data arrays from the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The number of samples contained in the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="items(int)"> +<h3>items</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a></span> <span class="element-name">items</span><wbr><span class="parameters">(int i)</span></div> +<div class="block">Returns a single item from the samples contained in the sketch. Does not perform bounds + checking on the input. If this is the first getter call, copies data arrays from the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>i</code> - An index into the list of samples</dd> +<dt>Returns:</dt> +<dd>The sample at array position <code>i</code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="weights()"> +<h3>weights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">weights</span>()</div> +<div class="block">Returns a copy of the array of weights contained in the sketch. If this is the first + getter call, copies data arrays from the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The number of samples contained in the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="weights(int)"> +<h3>weights</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">weights</span><wbr><span class="parameters">(int i)</span></div> +<div class="block">Returns a single weight from the samples contained in the sketch. Does not perform bounds + checking on the input. If this is the first getter call, copies data arrays from the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>i</code> - An index into the list of weights</dd> +<dt>Returns:</dt> +<dd>The weight at array position <code>i</code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSketch.html new file mode 100644 index 000000000..f67fb20ac --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsSketch.html @@ -0,0 +1,431 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>VarOptItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: VarOptItemsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/VarOptItemsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class VarOptItemsSketch" class="title">Class VarOptItemsSketch<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.VarOptItemsSketch<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of object held in the sketch.</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">VarOptItemsSketch<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This sketch provides a variance optimal sample over an input stream of weighted items. The + sketch can be used to compute subset sums over predicates, producing estimates with optimal + variance for a given sketch size. + + <p>Using this sketch with uniformly constant item weights (e.g. 1.0) will produce a standard + reservoir sample over the steam.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> predicate)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the + sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getN()" class="member-name-link">getN</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of items processed from the input stream</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumSamples()" class="member-name-link">getNumSamples</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the current number of items in the sketch, which may be smaller than the + sketch capacity.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSketchSamples()" class="member-name-link">getSketchSamples</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets a result iterator object.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a varopt sampling sketch with up to k samples using the default resize factor (8).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Construct a varopt sampling sketch with up to k samples using the specified resize factor.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human-readable summary of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a VarOptItemsSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a VarOptItemsSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(T,double)" class="member-name-link">update</a><wbr>(<a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a> item, + double weight)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newInstance(int)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int k)</span></div> +<div class="block">Construct a varopt sampling sketch with up to k samples using the default resize factor (8).</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of object held in the sketch.</dd> +<dt>Parameters:</dt> +<dd><code>k</code> - Maximum size of sampling. Allocated size may be smaller until sketch fills. + Unlike many sketches in this package, this value does <em>not</em> need to be a + power of 2.</dd> +<dt>Returns:</dt> +<dd>A VarOptItemsSketch initialized with maximum size k and resize factor rf.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newInstance(int,org.apache.datasketches.common.ResizeFactor)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int k, + <a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</span></div> +<div class="block">Construct a varopt sampling sketch with up to k samples using the specified resize factor.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of object held in the sketch.</dd> +<dt>Parameters:</dt> +<dd><code>k</code> - Maximum size of sampling. Allocated size may be smaller until sketch fills. + Unlike many sketches in this package, this value does <em>not</em> need to be a + power of 2. The maximum size is Integer.MAX_VALUE-1.</dd> +<dd><code>rf</code> - <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> +<dt>Returns:</dt> +<dd>A VarOptItemsSketch initialized with maximum size k and resize factor rf.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item this sketch contains</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - a Memory representation of a sketch of this class. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a sketch instance of this class</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getK</span>()</div> +<div class="block">Returns the sketch's value of <i>k</i>, the maximum number of samples stored in the + sketch. The current number of items in the sketch may be lower.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>k, the maximum number of samples in the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getN()"> +<h3>getN</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getN</span>()</div> +<div class="block">Returns the number of items processed from the input stream</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>n, the number of stream items the sketch has seen</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumSamples()"> +<h3>getNumSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumSamples</span>()</div> +<div class="block">Returns the current number of items in the sketch, which may be smaller than the + sketch capacity.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of items currently in the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSketchSamples()"> +<h3>getSketchSamples</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>></span> <span class="element-name">getSketchSamples</span>()</div> +<div class="block">Gets a result iterator object.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>An object with an iterator over the results</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(T,double)"> +<h3 id="update(java.lang.Object,double)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a> item, + double weight)</span></div> +<div class="block">Randomly decide whether or not to include an item in the sample set.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>item</code> - an item of the set being sampled from</dd> +<dd><code>weight</code> - a strictly positive weight associated with the item</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state, but retains the original value of k.</div> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human-readable summary of the sketch.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>A string version of the sketch summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a VarOptItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a VarOptItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a VarOptItemsSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a VarOptItemsSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> serDe)</span></div> +<div class="block">Returns a byte array representation of this sketch. May fail for polymorphic item types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><? super <a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Returns a byte array representation of this sketch. Copies contents into an array of the + specified class for serialization to allow for polymorphic types.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dd><code>clazz</code> - The class represented by <T></dd> +<dt>Returns:</dt> +<dd>a byte array representation of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="estimateSubsetSum(java.util.function.Predicate)"> +<h3>estimateSubsetSum</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></span> <span class="element-name">estimateSubsetSum</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> predicate)</span></div> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate. Provides a lower bound, estimate, and upper bound using a target of 2 standard + deviations. + + <p>This is technically a heuristic method, and tries to err on the conservative side.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>predicate</code> - A predicate to use when identifying items.</dd> +<dt>Returns:</dt> +<dd>A summary object containing the estimate, upper and lower bounds, and the total + sketch weight.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsUnion.html b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsUnion.html new file mode 100644 index 000000000..5173d0715 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/VarOptItemsUnion.html @@ -0,0 +1,322 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>VarOptItemsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling, class: VarOptItemsUnion"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/VarOptItemsUnion.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.sampling</a></div> +<h1 title="Class VarOptItemsUnion" class="title">Class VarOptItemsUnion<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.sampling.VarOptItemsUnion<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - Type of items</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">VarOptItemsUnion<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Provides a unioning operation over varopt sketches. This union allows the sample size k to float, + possibly increasing or decreasing as warranted by the available data.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Jon Malkin, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the varopt sketch resulting from the union of any input sketches.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int maxK)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates an empty Union with a maximum capacity of size k.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch to the empty state, but retains the original value of max k.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this union</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)" class="member-name-link">toByteArray</a><wbr>(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a byte array representation of this union.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">update</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Union the given Memory image of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.sampling.ReservoirItemsSketch)" class="member-name-link">update</a><wbr>(<a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> reservoirIn)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Union a reservoir sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.sampling.VarOptItemsSketch)" class="member-name-link">update</a><wbr>(<a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> sketchIn)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Union the given sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newInstance(int)"> +<h3>newInstance</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(int maxK)</span></div> +<div class="block">Creates an empty Union with a maximum capacity of size k.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item this union contains</dd> +<dt>Parameters:</dt> +<dd><code>maxK</code> - The maximum allowed capacity of the unioned result</dd> +<dt>Returns:</dt> +<dd>A new VarOptItemsUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</span></div> +<div class="block">Instantiates a Union from Memory</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - The type of item this sketch contains</dd> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Memory object containing a serialized union</dd> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>A VarOptItemsUnion created from the provided Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.sampling.VarOptItemsSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> sketchIn)</span></div> +<div class="block">Union the given sketch. + +<p>This method can be repeatedly called.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - The sketch to be merged</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + <a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe)</span></div> +<div class="block">Union the given Memory image of the sketch. + +<p>This method can be repeatedly called.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory image of sketch to be merged</dd> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(org.apache.datasketches.sampling.ReservoirItemsSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> reservoirIn)</span></div> +<div class="block">Union a reservoir sketch. The reservoir sample is treated as if all items were added with a + weight of 1.0.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>reservoirIn</code> - The reservoir sketch to be merged</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the varopt sketch resulting from the union of any input sketches.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>A varopt sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch to the empty state, but retains the original value of max k.</div> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human-readable summary of the sketch, without items.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>A string version of the sketch summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe)</span></div> +<div class="block">Returns a byte array representation of this union</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this union</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray(org.apache.datasketches.common.ArrayOfItemsSerDe,java.lang.Class)"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><<a href="VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> serDe, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> +<div class="block">Returns a byte array representation of this union. This method should be used when the array + elements are subclasses of a common base class.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>serDe</code> - An instance of ArrayOfItemsSerDe</dd> +<dd><code>clazz</code> - A class to which the items are cast before serialization</dd> +<dt>Returns:</dt> +<dd>a byte array representation of this union</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/EbppsItemsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/EbppsItemsSketch.html new file mode 100644 index 000000000..6f3089c25 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/EbppsItemsSketch.html @@ -0,0 +1,105 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.EbppsItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: EbppsItemsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.EbppsItemsSketch" class="title">Uses of Class<br>org.apache.datasketches.sampling.EbppsItemsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">EbppsItemsSketch.</span><code><a href="../EbppsItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> with parameters of type <a href="../EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">EbppsItemsSketch.</span><code><a href="../EbppsItemsSketch.html#merge(org.apache.datasketches.sampling.EbppsItemsSketch)" class="member-name-link">merge</a><wbr>(<a href="../EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><<a href="../EbppsItemsSketch.html" title="type parameter in EbppsItemsSketch">T</a>> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">Merges the provided sketch into the current one.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirItemsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirItemsSketch.html new file mode 100644 index 000000000..34d7cb157 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirItemsSketch.html @@ -0,0 +1,127 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.ReservoirItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: ReservoirItemsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.ReservoirItemsSketch" class="title">Uses of Class<br>org.apache.datasketches.sampling.ReservoirItemsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="../ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../ReservoirItemsUnion.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a sketch representing the current state of the union.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../ReservoirItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../ReservoirItemsSketch.html#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct a mergeable sampling sketch with up to k samples using the default resize + factor (8).</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../ReservoirItemsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct a mergeable sampling sketch with up to k samples using a specified resize factor.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> with parameters of type <a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../ReservoirItemsUnion.html#update(org.apache.datasketches.sampling.ReservoirItemsSketch)" class="member-name-link">update</a><wbr>(<a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="../ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>> sketchIn)</code></div> +<div class="col-last even-row-color"> +<div class="block">Union the given sketch.</div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../VarOptItemsUnion.html#update(org.apache.datasketches.sampling.ReservoirItemsSketch)" class="member-name-link">update</a><wbr>(<a href="../ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="../VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> reservoirIn)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Union a reservoir sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirItemsUnion.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirItemsUnion.html new file mode 100644 index 000000000..578e51e96 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirItemsUnion.html @@ -0,0 +1,98 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.ReservoirItemsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: ReservoirItemsUnion"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.ReservoirItemsUnion" class="title">Uses of Class<br>org.apache.datasketches.sampling.ReservoirItemsUnion</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../ReservoirItemsUnion.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirItemsUnion.</span><code><a href="../ReservoirItemsUnion.html#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int maxK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirLongsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirLongsSketch.html new file mode 100644 index 000000000..4de2b4eb7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirLongsSketch.html @@ -0,0 +1,122 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.ReservoirLongsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: ReservoirLongsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.ReservoirLongsSketch" class="title">Uses of Class<br>org.apache.datasketches.sampling.ReservoirLongsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirLongsUnion.</span><code><a href="../ReservoirLongsUnion.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a sketch representing the current state of the union.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirLongsSketch.</span><code><a href="../ReservoirLongsSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, which must be a Memory + representation of this sketch class.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirLongsSketch.</span><code><a href="../ReservoirLongsSketch.html#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirLongsSketch.</span><code><a href="../ReservoirLongsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct a mergeable reservoir sampling sketch with up to k samples using the default resize + factor (8).</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> with parameters of type <a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirLongsUnion.</span><code><a href="../ReservoirLongsUnion.html#update(org.apache.datasketches.sampling.ReservoirLongsSketch)" class="member-name-link">update</a><wbr>(<a href="../ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a> sketchIn)</code></div> +<div class="col-last even-row-color"> +<div class="block">Union the given sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirLongsUnion.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirLongsUnion.html new file mode 100644 index 000000000..c01edae90 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/ReservoirLongsUnion.html @@ -0,0 +1,97 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.ReservoirLongsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: ReservoirLongsUnion"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.ReservoirLongsUnion" class="title">Uses of Class<br>org.apache.datasketches.sampling.ReservoirLongsUnion</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirLongsUnion.</span><code><a href="../ReservoirLongsUnion.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirLongsUnion.</span><code><a href="../ReservoirLongsUnion.html#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int maxK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an empty Union with a maximum reservoir capacity of size k.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/SampleSubsetSummary.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/SampleSubsetSummary.html new file mode 100644 index 000000000..05e4f88f1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/SampleSubsetSummary.html @@ -0,0 +1,105 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.SampleSubsetSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: SampleSubsetSummary"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.SampleSubsetSummary" class="title">Uses of Class<br>org.apache.datasketches.sampling.SampleSubsetSummary</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ReservoirItemsSketch.</span><code><a href="../ReservoirItemsSketch.html#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="../ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>> predicate)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ReservoirLongsSketch.</span><code><a href="../ReservoirLongsSketch.html#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> predicate)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</div> +<div class="col-first even-row-color"><code><a href="../SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../VarOptItemsSketch.html#estimateSubsetSum(java.util.function.Predicate)" class="member-name-link">estimateSubsetSum</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="../VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>> predicate)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes an estimated subset sum from the entire stream for objects matching a given + predicate.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.VarOptItemsIterator.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.VarOptItemsIterator.html new file mode 100644 index 000000000..73a98995d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.VarOptItemsIterator.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.VarOptItemsSamples.VarOptItemsIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: VarOptItemsSamples, class: VarOptItemsIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../VarOptItemsSamples.VarOptItemsIterator.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.VarOptItemsSamples.VarOptItemsIterator" class="title">Uses of Class<br>org.apache.datasketches.sampling.VarOptItemsSamples.VarOptItemsIterator</h1> +</div> +No usage of org.apache.datasketches.sampling.VarOptItemsSamples.VarOptItemsIterator</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.WeightedSample.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.WeightedSample.html new file mode 100644 index 000000000..a238368e3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.WeightedSample.html @@ -0,0 +1,99 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.VarOptItemsSamples.WeightedSample (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: VarOptItemsSamples, class: WeightedSample"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.VarOptItemsSamples.WeightedSample" class="title">Uses of Class<br>org.apache.datasketches.sampling.VarOptItemsSamples.WeightedSample</h1> +</div> +<div class="caption"><span>Packages that use <a href="../VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="../VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="../VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsSamples.VarOptItemsIterator.</span><code><a href="../VarOptItemsSamples.VarOptItemsIterator.html#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return types with arguments of type <a href="../VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="../VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>>.<a href="../VarOptItemsSamples.WeightedSample.html" title="class in org.apache.datasketches.sampling">WeightedSample</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsSamples.</span><code><a href="../VarOptItemsSamples.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.html new file mode 100644 index 000000000..bfb684baa --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSamples.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.VarOptItemsSamples (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: VarOptItemsSamples"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.VarOptItemsSamples" class="title">Uses of Class<br>org.apache.datasketches.sampling.VarOptItemsSamples</h1> +</div> +<div class="caption"><span>Packages that use <a href="../VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="../VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../VarOptItemsSketch.html#getSketchSamples()" class="member-name-link">getSketchSamples</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets a result iterator object.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSketch.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSketch.html new file mode 100644 index 000000000..5ebb492b0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsSketch.html @@ -0,0 +1,121 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.VarOptItemsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: VarOptItemsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.VarOptItemsSketch" class="title">Uses of Class<br>org.apache.datasketches.sampling.VarOptItemsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="../VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../VarOptItemsUnion.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the varopt sketch resulting from the union of any input sketches.</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../VarOptItemsSketch.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a sketch instance of this class from the given srcMem, + which must be a Memory representation of this sketch class.</div> +</div> +<div class="col-first even-row-color"><code>static <T> <a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../VarOptItemsSketch.html#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int k)</code></div> +<div class="col-last even-row-color"> +<div class="block">Construct a varopt sampling sketch with up to k samples using the default resize factor (8).</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">VarOptItemsSketch.</span><code><a href="../VarOptItemsSketch.html#newInstance(int,org.apache.datasketches.common.ResizeFactor)" class="member-name-link">newInstance</a><wbr>(int k, + <a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Construct a varopt sampling sketch with up to k samples using the specified resize factor.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> with parameters of type <a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../VarOptItemsUnion.html#update(org.apache.datasketches.sampling.VarOptItemsSketch)" class="member-name-link">update</a><wbr>(<a href="../VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="../VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>> sketchIn)</code></div> +<div class="col-last even-row-color"> +<div class="block">Union the given sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsUnion.html b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsUnion.html new file mode 100644 index 000000000..747c7f9df --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/class-use/VarOptItemsUnion.html @@ -0,0 +1,98 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.sampling.VarOptItemsUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling, class: VarOptItemsUnion"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.sampling.VarOptItemsUnion" class="title">Uses of Class<br>org.apache.datasketches.sampling.VarOptItemsUnion</h1> +</div> +<div class="caption"><span>Packages that use <a href="../VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<h2>Uses of <a href="../VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a> in <a href="../package-summary.html">org.apache.datasketches.sampling</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.sampling</a> that return <a href="../VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <T> <a href="../VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></code></div> +<div class="col-second even-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../VarOptItemsUnion.html#heapify(org.apache.datasketches.memory.Memory,org.apache.datasketches.common.ArrayOfItemsSerDe)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../../common/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> serDe)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiates a Union from Memory</div> +</div> +<div class="col-first odd-row-color"><code>static <T> <a href="../VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">VarOptItemsUnion.</span><code><a href="../VarOptItemsUnion.html#newInstance(int)" class="member-name-link">newInstance</a><wbr>(int maxK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an empty Union with a maximum capacity of size k.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/package-summary.html b/docs/7.0.X/org/apache/datasketches/sampling/package-summary.html new file mode 100644 index 000000000..3832ded10 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/package-summary.html @@ -0,0 +1,151 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.sampling (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.sampling"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.sampling" class="title">Package org.apache.datasketches.sampling</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.sampling</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream. + + <p>These sketches are mergeable and can be serialized and deserialized to/from a compact + form.</p></div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling"><code>ReservoirItemsSketch</code></a></li> +<li><a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling"><code>ReservoirLongsSketch</code></a></li> +<li><a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling"><code>VarOptItemsSketch</code></a></li> +</ul> +</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">An implementation of an Exact and Bounded Sampling Proportional to Size sketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This sketch provides a reservoir sample over an input stream of items.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Class to union reservoir samples of generic items.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This sketch provides a reservoir sample over an input stream of <code>long</code>s.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Class to union reservoir samples of longs.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">A simple object o capture the results of a subset sum query on a sampling sketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This class provides access to the samples contained in a VarOptItemsSketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This sketch provides a variance optimal sample over an input stream of weighted items.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Provides a unioning operation over varopt sketches.</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/package-tree.html b/docs/7.0.X/org/apache/datasketches/sampling/package-tree.html new file mode 100644 index 000000000..d3a554863 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/package-tree.html @@ -0,0 +1,86 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.sampling Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.sampling"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.sampling</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.sampling.<a href="EbppsItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.sampling.<a href="ReservoirItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.sampling.<a href="ReservoirItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></li> +<li class="circle">org.apache.datasketches.sampling.<a href="ReservoirLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="ReservoirLongsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="SampleSubsetSummary.html" class="type-name-link" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="VarOptItemsSamples.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><T> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><T>)</li> +<li class="circle">org.apache.datasketches.sampling.<a href="VarOptItemsSamples.VarOptItemsIterator.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.VarOptItemsIterator</a> (implements java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><E>)</li> +<li class="circle">org.apache.datasketches.sampling.<a href="VarOptItemsSamples.WeightedSample.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="VarOptItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.sampling.<a href="VarOptItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/sampling/package-use.html b/docs/7.0.X/org/apache/datasketches/sampling/package-use.html new file mode 100644 index 000000000..cfb1759bb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/sampling/package-use.html @@ -0,0 +1,125 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.sampling (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.sampling"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.sampling" class="title">Uses of Package<br>org.apache.datasketches.sampling</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.sampling</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of + weighted and unweighted items from a stream.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.sampling"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.sampling</a> used by <a href="package-summary.html">org.apache.datasketches.sampling</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/EbppsItemsSketch.html#org.apache.datasketches.sampling">EbppsItemsSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">An implementation of an Exact and Bounded Sampling Proportional to Size sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ReservoirItemsSketch.html#org.apache.datasketches.sampling">ReservoirItemsSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This sketch provides a reservoir sample over an input stream of items.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ReservoirItemsUnion.html#org.apache.datasketches.sampling">ReservoirItemsUnion</a></div> +<div class="col-last even-row-color"> +<div class="block">Class to union reservoir samples of generic items.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ReservoirLongsSketch.html#org.apache.datasketches.sampling">ReservoirLongsSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This sketch provides a reservoir sample over an input stream of <code>long</code>s.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ReservoirLongsUnion.html#org.apache.datasketches.sampling">ReservoirLongsUnion</a></div> +<div class="col-last even-row-color"> +<div class="block">Class to union reservoir samples of longs.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SampleSubsetSummary.html#org.apache.datasketches.sampling">SampleSubsetSummary</a></div> +<div class="col-last odd-row-color"> +<div class="block">A simple object o capture the results of a subset sum query on a sampling sketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/VarOptItemsSamples.html#org.apache.datasketches.sampling">VarOptItemsSamples</a></div> +<div class="col-last even-row-color"> +<div class="block">This class provides access to the samples contained in a VarOptItemsSketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/VarOptItemsSamples.WeightedSample.html#org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></div> +<div class="col-last odd-row-color"> +<div class="block">A convenience class to allow easy iterator access to a VarOpt sample.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/VarOptItemsSketch.html#org.apache.datasketches.sampling">VarOptItemsSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">This sketch provides a variance optimal sample over an input stream of weighted items.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/VarOptItemsUnion.html#org.apache.datasketches.sampling">VarOptItemsUnion</a></div> +<div class="col-last odd-row-color"> +<div class="block">Provides a unioning operation over varopt sketches.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/BinarySearch.html b/docs/7.0.X/org/apache/datasketches/tdigest/BinarySearch.html new file mode 100644 index 000000000..4918cfbdb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/BinarySearch.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BinarySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tdigest, class: BinarySearch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BinarySearch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tdigest</a></div> +<h1 title="Class BinarySearch" class="title">Class BinarySearch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tdigest.BinarySearch</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BinarySearch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Algorithms with logarithmic complexity for searching in an array.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BinarySearch</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>BinarySearch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BinarySearch</span>()</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/Sort.html b/docs/7.0.X/org/apache/datasketches/tdigest/Sort.html new file mode 100644 index 000000000..e04829bf8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/Sort.html @@ -0,0 +1,216 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Sort (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tdigest, class: Sort"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Sort.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tdigest</a></div> +<h1 title="Class Sort" class="title">Class Sort</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tdigest.Sort</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Sort</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Specialized sorting algorithm that can sort one array and permute another array the same way.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Sort</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#reverse(double%5B%5D,int)" class="member-name-link">reverse</a><wbr>(double[] values, + int n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Reverse the first n elements of the given array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#reverse(long%5B%5D,int)" class="member-name-link">reverse</a><wbr>(long[] values, + int n)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Reverse the first n elements of the given array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stableSort(double%5B%5D,long%5B%5D,int)" class="member-name-link">stableSort</a><wbr>(double[] keys, + long[] values, + int n)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Stable sort two arrays.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>Sort</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Sort</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="stableSort(double[],long[],int)"> +<h3>stableSort</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">stableSort</span><wbr><span class="parameters">(double[] keys, + long[] values, + int n)</span></div> +<div class="block">Stable sort two arrays. + The first array is sorted while the second array is permuted the same way.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>keys</code> - array to be sorted</dd> +<dd><code>values</code> - array to be permuted the same way</dd> +<dd><code>n</code> - number of elements to sort from the beginning of the arrays</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reverse(double[],int)"> +<h3>reverse</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">reverse</span><wbr><span class="parameters">(double[] values, + int n)</span></div> +<div class="block">Reverse the first n elements of the given array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>values</code> - array to be reversed</dd> +<dd><code>n</code> - number of elements to reverse</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reverse(long[],int)"> +<h3>reverse</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">reverse</span><wbr><span class="parameters">(long[] values, + int n)</span></div> +<div class="block">Reverse the first n elements of the given array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>values</code> - array to be reversed</dd> +<dd><code>n</code> - number of elements to reverse</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/TDigestDouble.html b/docs/7.0.X/org/apache/datasketches/tdigest/TDigestDouble.html new file mode 100644 index 000000000..ab5500bf1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/TDigestDouble.html @@ -0,0 +1,496 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>TDigestDouble (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tdigest, class: TDigestDouble"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/TDigestDouble.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tdigest</a></div> +<h1 title="Class TDigestDouble" class="title">Class TDigestDouble</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tdigest.TDigestDouble</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">TDigestDouble</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">t-Digest for estimating quantiles and ranks. + This implementation is based on the following paper: + Ted Dunning, Otmar Ertl. Extremely Accurate Quantiles Using t-Digests + and the following implementation: + https://github.com/tdunning/t-digest + This implementation is similar to MergingDigest in the above implementation</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final short</code></div> +<div class="col-second even-row-color"><code><a href="#DEFAULT_K" class="member-name-link">DEFAULT_K</a></code></div> +<div class="col-last even-row-color"> +<div class="block">the default value of K if one is not specified</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TDigestDouble</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor with the default K</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(short)" class="member-name-link">TDigestDouble</a><wbr>(short k)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructor</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCDF(double%5B%5D)" class="member-name-link">getCDF</a><wbr>(double[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF), which is the + cumulative analog of the PMF, of the input stream given a set of split points.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>short</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getK()" class="member-name-link">getK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxValue()" class="member-name-link">getMaxValue</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinValue()" class="member-name-link">getMinValue</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPMF(double%5B%5D)" class="member-name-link">getPMF</a><wbr>(double[] splitPoints)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + given a set of split points.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantile(double)" class="member-name-link">getQuantile</a><wbr>(double rank)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Compute approximate quantile value corresponding to the given normalized rank</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRank(double)" class="member-name-link">getRank</a><wbr>(double value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Compute approximate normalized rank of the given value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotalWeight()" class="member-name-link">getTotalWeight</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Deserialize TDigest from a given memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,boolean)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + boolean isFloat)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Deserialize TDigest from a given memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#merge(org.apache.datasketches.tdigest.TDigestDouble)" class="member-name-link">merge</a><wbr>(<a href="TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a> other)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Merge the given TDigest into this one</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Serialize this TDigest to a byte array form.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human-readable summary of this TDigest as a string</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean)" class="member-name-link">toString</a><wbr>(boolean printCentroids)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Human-readable summary of this TDigest as a string</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Update this TDigest with the given value</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DEFAULT_K"> +<h3>DEFAULT_K</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">short</span> <span class="element-name">DEFAULT_K</span></div> +<div class="block">the default value of K if one is not specified</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.tdigest.TDigestDouble.DEFAULT_K">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>TDigestDouble</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TDigestDouble</span>()</div> +<div class="block">Constructor with the default K</div> +</section> +</li> +<li> +<section class="detail" id="<init>(short)"> +<h3>TDigestDouble</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TDigestDouble</span><wbr><span class="parameters">(short k)</span></div> +<div class="block">Constructor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>k</code> - affects the size of TDigest and its estimation error</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getK()"> +<h3>getK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">short</span> <span class="element-name">getK</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>parameter k (compression) that was used to configure this TDigest</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double value)</span></div> +<div class="block">Update this TDigest with the given value</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - to update the TDigest with</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="merge(org.apache.datasketches.tdigest.TDigestDouble)"> +<h3>merge</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a> other)</span></div> +<div class="block">Merge the given TDigest into this one</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>other</code> - TDigest to merge</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if TDigest has not seen any data</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMinValue()"> +<h3>getMinValue</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getMinValue</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>minimum value seen by TDigest</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxValue()"> +<h3>getMaxValue</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getMaxValue</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>maximum value seen by TDigest</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getTotalWeight()"> +<h3>getTotalWeight</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getTotalWeight</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>total weight</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRank(double)"> +<h3>getRank</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRank</span><wbr><span class="parameters">(double value)</span></div> +<div class="block">Compute approximate normalized rank of the given value.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - to be ranked</dd> +<dt>Returns:</dt> +<dd>normalized rank (from 0 to 1 inclusive)</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getQuantile(double)"> +<h3>getQuantile</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getQuantile</span><wbr><span class="parameters">(double rank)</span></div> +<div class="block">Compute approximate quantile value corresponding to the given normalized rank</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rank</code> - normalized rank (from 0 to 1 inclusive)</dd> +<dt>Returns:</dt> +<dd>quantile value corresponding to the given rank</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPMF(double[])"> +<h3>getPMF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getPMF</span><wbr><span class="parameters">(double[] splitPoints)</span></div> +<div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream + given a set of split points.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing values + that divide the input domain into <i>m+1</i> consecutive disjoint intervals (bins).</dd> +<dt>Returns:</dt> +<dd>an array of m+1 doubles each of which is an approximation + to the fraction of the input stream values (the mass) that fall into one of those intervals.</dd> +<dt>Throws:</dt> +<dd><code><a href="../common/SketchesStateException.html" title="class in org.apache.datasketches.common">SketchesStateException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCDF(double[])"> +<h3>getCDF</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">getCDF</span><wbr><span class="parameters">(double[] splitPoints)</span></div> +<div class="block">Returns an approximation to the Cumulative Distribution Function (CDF), which is the + cumulative analog of the PMF, of the input stream given a set of split points.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing values + that divide the input domain into <i>m+1</i> consecutive disjoint intervals.</dd> +<dt>Returns:</dt> +<dd>an array of m+1 doubles, which are a consecutive approximation to the CDF + of the input stream given the splitPoints. The value at array position j of the returned + CDF array is the sum of the returned values in positions 0 through j of the returned PMF + array. This can be viewed as array of ranks of the given split points plus one more value + that is always 1.</dd> +<dt>Throws:</dt> +<dd><code><a href="../common/SketchesStateException.html" title="class in org.apache.datasketches.common">SketchesStateException</a></code> - if sketch is empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Serialize this TDigest to a byte array form.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>byte array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Deserialize TDigest from a given memory. + Supports reading format of the reference implementation (autodetected).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - instance of Memory</dd> +<dt>Returns:</dt> +<dd>an instance of TDigest</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,boolean)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + boolean isFloat)</span></div> +<div class="block">Deserialize TDigest from a given memory. Supports reading compact format + with (float, int) centroids as opposed to (double, long) to represent (mean, weight). + Supports reading format of the reference implementation (autodetected).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - instance of Memory</dd> +<dd><code>isFloat</code> - if true the input represents (float, int) format</dd> +<dt>Returns:</dt> +<dd>an instance of TDigest</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Human-readable summary of this TDigest as a string</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>summary of this TDigest</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean printCentroids)</span></div> +<div class="block">Human-readable summary of this TDigest as a string</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>printCentroids</code> - if true append the list of centroids with weights</dd> +<dt>Returns:</dt> +<dd>summary of this TDigest</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/class-use/BinarySearch.html b/docs/7.0.X/org/apache/datasketches/tdigest/class-use/BinarySearch.html new file mode 100644 index 000000000..2aeff2582 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/class-use/BinarySearch.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tdigest.BinarySearch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tdigest, class: BinarySearch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BinarySearch.html" title="class in org.apache.datasketches.tdigest">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tdigest.BinarySearch" class="title">Uses of Class<br>org.apache.datasketches.tdigest.BinarySearch</h1> +</div> +No usage of org.apache.datasketches.tdigest.BinarySearch</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/class-use/Sort.html b/docs/7.0.X/org/apache/datasketches/tdigest/class-use/Sort.html new file mode 100644 index 000000000..98e29dbad --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/class-use/Sort.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tdigest.Sort (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tdigest, class: Sort"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Sort.html" title="class in org.apache.datasketches.tdigest">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tdigest.Sort" class="title">Uses of Class<br>org.apache.datasketches.tdigest.Sort</h1> +</div> +No usage of org.apache.datasketches.tdigest.Sort</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/class-use/TDigestDouble.html b/docs/7.0.X/org/apache/datasketches/tdigest/class-use/TDigestDouble.html new file mode 100644 index 000000000..c4d524fd1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/class-use/TDigestDouble.html @@ -0,0 +1,108 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tdigest.TDigestDouble (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tdigest, class: TDigestDouble"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tdigest.TDigestDouble" class="title">Uses of Class<br>org.apache.datasketches.tdigest.TDigestDouble</h1> +</div> +<div class="caption"><span>Packages that use <a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tdigest">org.apache.datasketches.tdigest</a></div> +<div class="col-last even-row-color"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tdigest"> +<h2>Uses of <a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a> in <a href="../package-summary.html">org.apache.datasketches.tdigest</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tdigest</a> that return <a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">TDigestDouble.</span><code><a href="../TDigestDouble.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Deserialize TDigest from a given memory.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">TDigestDouble.</span><code><a href="../TDigestDouble.html#heapify(org.apache.datasketches.memory.Memory,boolean)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + boolean isFloat)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Deserialize TDigest from a given memory.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tdigest</a> with parameters of type <a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">TDigestDouble.</span><code><a href="../TDigestDouble.html#merge(org.apache.datasketches.tdigest.TDigestDouble)" class="member-name-link">merge</a><wbr>(<a href="../TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a> other)</code></div> +<div class="col-last even-row-color"> +<div class="block">Merge the given TDigest into this one</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/package-summary.html b/docs/7.0.X/org/apache/datasketches/tdigest/package-summary.html new file mode 100644 index 000000000..b5f6ad536 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/package-summary.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tdigest (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tdigest"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.tdigest" class="title">Package org.apache.datasketches.tdigest</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.tdigest</span></div> +<section class="package-description" id="package-description"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BinarySearch.html" title="class in org.apache.datasketches.tdigest">BinarySearch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Algorithms with logarithmic complexity for searching in an array.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Sort.html" title="class in org.apache.datasketches.tdigest">Sort</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Specialized sorting algorithm that can sort one array and permute another array the same way.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TDigestDouble.html" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/package-tree.html b/docs/7.0.X/org/apache/datasketches/tdigest/package-tree.html new file mode 100644 index 000000000..eefdd22ef --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/package-tree.html @@ -0,0 +1,78 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tdigest Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.tdigest"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.tdigest</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.tdigest.<a href="BinarySearch.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">BinarySearch</a></li> +<li class="circle">org.apache.datasketches.tdigest.<a href="Sort.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">Sort</a></li> +<li class="circle">org.apache.datasketches.tdigest.<a href="TDigestDouble.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tdigest/package-use.html b/docs/7.0.X/org/apache/datasketches/tdigest/package-use.html new file mode 100644 index 000000000..e3723ef88 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tdigest/package-use.html @@ -0,0 +1,88 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.tdigest (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tdigest"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.tdigest" class="title">Uses of Package<br>org.apache.datasketches.tdigest</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.tdigest</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tdigest">org.apache.datasketches.tdigest</a></div> +<div class="col-last even-row-color"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tdigest"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tdigest</a> used by <a href="package-summary.html">org.apache.datasketches.tdigest</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/TDigestDouble.html#org.apache.datasketches.tdigest">TDigestDouble</a></div> +<div class="col-last even-row-color"> +<div class="block">t-Digest for estimating quantiles and ranks.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/AnotB.html b/docs/7.0.X/org/apache/datasketches/theta/AnotB.html new file mode 100644 index 000000000..ab381367b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/AnotB.html @@ -0,0 +1,421 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>AnotB (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: AnotB"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/AnotB.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class AnotB" class="title">Class AnotB</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">org.apache.datasketches.theta.SetOperation</a> +<div class="inheritance">org.apache.datasketches.theta.AnotB</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AnotB</span> +<span class="extends-implements">extends <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span></div> +<div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches. + This class includes both stateful and stateless operations. + + <p>The stateful operation is as follows:</p> + <pre><code> + AnotB anotb = SetOperationBuilder.buildAnotB(); + + anotb.setA(Sketch skA); //The first argument. + anotb.notB(Sketch skB); //The second (subtraction) argument. + anotb.notB(Sketch skC); // ...any number of additional subtractions... + anotb.getResult(false); //Get an interim result. + anotb.notB(Sketch skD); //Additional subtractions. + anotb.getResult(true); //Final result and resets the AnotB operator. + </code></pre> + + <p>The stateless operation is as follows:</p> + <pre><code> + AnotB anotb = SetOperationBuilder.buildAnotB(); + + CompactSketch csk = anotb.aNotB(Sketch skA, Sketch skB); + </code></pre> + + <p>Calling the <i>setA</i> operation a second time essentially clears the internal state and loads + the new sketch.</p> + + <p>The stateless and stateful operations are independent of each other with the exception of + sharing the same update hash seed loaded as the default seed or specified by the user as an + argument to the builder.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AnotB</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as an + ordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">aNotB</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as a + CompactSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Family of this SetOperation</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult(boolean)" class="member-name-link">getResult</a><wbr>(boolean reset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="#setA(org.apache.datasketches.theta.Sketch)"><code>setA(Sketch)</code></a> and (<a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(Sketch)</code></a> or + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult(boolean,org.apache.datasketches.memory.WritableMemory,boolean)" class="member-name-link">getResult</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem, + boolean reset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="#setA(org.apache.datasketches.theta.Sketch)"><code>setA(Sketch)</code></a> and (<a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(Sketch)</code></a> or + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#notB(org.apache.datasketches.theta.Sketch)" class="member-name-link">notB</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setA(org.apache.datasketches.theta.Sketch)" class="member-name-link">setA</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.theta.SetOperation">Methods inherited from class org.apache.datasketches.theta.<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></h3> +<code><a href="SetOperation.html#builder()">builder</a>, <a href="SetOperation.html#getMaxAnotBResultBytes(int)">getMaxAnotBResultBytes</a>, <a href="SetOperation.html#getMaxIntersectionBytes(int)">getMaxIntersectionBytes</a>, <a href="SetOperation.html#getMaxUnionBytes(int)">getMaxUnionBytes</a>, <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)">heapify</a>, <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)">heapify</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory,long)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.MemoryStatus">Methods inherited from interface org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></h3> +<code><a href="../common/MemoryStatus.html#hasMemory()">hasMemory</a>, <a href="../common/MemoryStatus.html#isDirect()">isDirect</a>, <a href="../common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>AnotB</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AnotB</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SetOperation.html#getFamily()">SetOperation</a></code></span></div> +<div class="block">Gets the Family of this SetOperation</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SetOperation.html#getFamily()">getFamily</a></code> in class <code><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></dd> +<dt>Returns:</dt> +<dd>the Family of this SetOperation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setA(org.apache.datasketches.theta.Sketch)"> +<h3>setA</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">setA</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA)</span></div> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>. This overwrites the internal state of this + AnotB operator with the contents of the given sketch. + This sets the stage for multiple following <i>notB</i> steps. + + <p>An input argument of null will throw an exception.</p> + + <p>Rationale: In mathematics a "null set" is a set with no members, which we call an empty set. + That is distinctly different from the java <i>null</i>, which represents a nonexistent object. + In most cases it is a programming error due to some object that was not properly initialized. + With a null as the first argument, we cannot know what the user's intent is. + Since it is very likely that a <i>null</i> is a programming error, we throw a an exception.</p> + + <p>An empty input argument will set the internal state to empty.</p> + + <p>Rationale: An empty set is a mathematically legal concept. Although it makes any subsequent, + valid argument for B irrelevant, we must allow this and assume the user knows what they are + doing.</p> + + <p>Performing <a href="#getResult(boolean)"><code>getResult(boolean)</code></a> just after this step will return a compact form of + the given argument.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>skA</code> - The incoming sketch for the first argument, <i>A</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="notB(org.apache.datasketches.theta.Sketch)"> +<h3>notB</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">notB</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</span></div> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>. + Performs an <i>AND NOT</i> operation with the existing internal state of this AnotB operator. + + <p>An input argument of null or empty is ignored.</p> + + <p>Rationale: A <i>null</i> for the second or following arguments is more tolerable because + <i>A NOT null</i> is still <i>A</i> even if we don't know exactly what the null represents. It + clearly does not have any content that overlaps with <i>A</i>. Also, because this can be part of + a multistep operation with multiple <i>notB</i> steps. Other following steps can still produce + a valid result.</p> + + <p>Use <a href="#getResult(boolean)"><code>getResult(boolean)</code></a> to obtain the result.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>skB</code> - The incoming Theta sketch for the second (or following) argument <i>B</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(boolean)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(boolean reset)</span></div> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="#setA(org.apache.datasketches.theta.Sketch)"><code>setA(Sketch)</code></a> and (<a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(Sketch)</code></a> or + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>reset</code> - If <i>true</i>, clears this operator to the empty state after this result is + returned. Set this to <i>false</i> if you wish to obtain an intermediate result.</dd> +<dt>Returns:</dt> +<dd>the result of this operation as an ordered, on-heap <a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(boolean,org.apache.datasketches.memory.WritableMemory,boolean)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem, + boolean reset)</span></div> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="#setA(org.apache.datasketches.theta.Sketch)"><code>setA(Sketch)</code></a> and (<a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(Sketch)</code></a> or + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstOrdered</code> - If <i>true</i>, the result will be an ordered <a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a>. + <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a>.</dd> +<dd><code>dstMem</code> - if not <i>null</i> the given Memory will be the target location of the result. + <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dd><code>reset</code> - If <i>true</i>, clears this operator to the empty state after this result is + returned. Set this to <i>false</i> if you wish to obtain an intermediate result.</dd> +<dt>Returns:</dt> +<dd>the result of this operation as a <a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a> in the given dstMem.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>aNotB</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">aNotB</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</span></div> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as an + ordered CompactSketch on the heap. + + <p>This a stateless operation and has no impact on the internal state of this operator. + Thus, this is not an accumulating update and does not interact with the <a href="#setA(org.apache.datasketches.theta.Sketch)"><code>setA(Sketch)</code></a>, + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(Sketch)</code></a>, <a href="#getResult(boolean)"><code>getResult(boolean)</code></a>, or + <a href="#getResult(boolean,org.apache.datasketches.memory.WritableMemory,boolean)"><code>getResult(boolean, WritableMemory, boolean)</code></a> methods.</p> + + <p>If either argument is null an exception is thrown.</p> + + <p>Rationale: In mathematics a "null set" is a set with no members, which we call an empty set. + That is distinctly different from the java <i>null</i>, which represents a nonexistent object. + In most cases <i>null</i> is a programming error due to a non-initialized object. </p> + + <p>With a null as the first argument we cannot know what the user's intent is and throw an + exception. With a null as the second argument for this method we must return a result and + there is no following possible viable arguments for the second argument so we thrown an + exception.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>skA</code> - The incoming sketch for the first argument. It must not be null.</dd> +<dd><code>skB</code> - The incoming sketch for the second argument. It must not be null.</dd> +<dt>Returns:</dt> +<dd>an ordered CompactSketch on the heap</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>aNotB</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">aNotB</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as a + CompactSketch. + + <p>This a stateless operation and has no impact on the internal state of this operator. + Thus, this is not an accumulating update and does not interact with the <a href="#setA(org.apache.datasketches.theta.Sketch)"><code>setA(Sketch)</code></a>, + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(Sketch)</code></a>, <a href="#getResult(boolean)"><code>getResult(boolean)</code></a>, or + <a href="#getResult(boolean,org.apache.datasketches.memory.WritableMemory,boolean)"><code>getResult(boolean, WritableMemory, boolean)</code></a> methods.</p> + + <p>If either argument is null an exception is thrown.</p> + + <p>Rationale: In mathematics a "null set" is a set with no members, which we call an empty set. + That is distinctly different from the java <i>null</i>, which represents a nonexistent object. + In most cases <i>null</i> is a programming error due to a non-initialized object. </p> + + <p>With a null as the first argument we cannot know what the user's intent is and throw an + exception. With a null as the second argument for this method we must return a result and + there is no following possible viable arguments for the second argument so we thrown an + exception.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>skA</code> - The incoming sketch for the first argument. It must not be null.</dd> +<dd><code>skB</code> - The incoming sketch for the second argument. It must not be null.</dd> +<dd><code>dstOrdered</code> - <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a>.</dd> +<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dt>Returns:</dt> +<dd>the result as a CompactSketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/BitPacking.html b/docs/7.0.X/org/apache/datasketches/theta/BitPacking.html new file mode 100644 index 000000000..3a54b36b3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/BitPacking.html @@ -0,0 +1,214 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BitPacking (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: BitPacking"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BitPacking.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class BitPacking" class="title">Class BitPacking</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.theta.BitPacking</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">BitPacking</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Used as part of Theta compression.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BitPacking</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#packBits(long,int,byte%5B%5D,int,int)" class="member-name-link">packBits</a><wbr>(long value, + int bits, + byte[] buffer, + int bufOffset, + int bitOffset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The bit packing operation</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unpackBits(long%5B%5D,int,int,byte%5B%5D,int,int)" class="member-name-link">unpackBits</a><wbr>(long[] value, + int index, + int bits, + byte[] buffer, + int bufOffset, + int bitOffset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">The unpacking operation</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>BitPacking</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BitPacking</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="packBits(long,int,byte[],int,int)"> +<h3>packBits</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">packBits</span><wbr><span class="parameters">(long value, + int bits, + byte[] buffer, + int bufOffset, + int bitOffset)</span></div> +<div class="block">The bit packing operation</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - the value to pack</dd> +<dd><code>bits</code> - number of bits to pack</dd> +<dd><code>buffer</code> - the output byte array buffer</dd> +<dd><code>bufOffset</code> - the byte offset in the buffer</dd> +<dd><code>bitOffset</code> - the bit offset</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="unpackBits(long[],int,int,byte[],int,int)"> +<h3>unpackBits</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">unpackBits</span><wbr><span class="parameters">(long[] value, + int index, + int bits, + byte[] buffer, + int bufOffset, + int bitOffset)</span></div> +<div class="block">The unpacking operation</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - the output array</dd> +<dd><code>index</code> - index of the value array</dd> +<dd><code>bits</code> - the number of bits to unpack</dd> +<dd><code>buffer</code> - the input packed buffer</dd> +<dd><code>bufOffset</code> - the buffer offset</dd> +<dd><code>bitOffset</code> - the bit offset</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/CompactSketch.html b/docs/7.0.X/org/apache/datasketches/theta/CompactSketch.html new file mode 100644 index 000000000..08db85fb4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/CompactSketch.html @@ -0,0 +1,429 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CompactSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: CompactSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CompactSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class CompactSketch" class="title">Class CompactSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="Sketch.html" title="class in org.apache.datasketches.theta">org.apache.datasketches.theta.Sketch</a> +<div class="inheritance">org.apache.datasketches.theta.CompactSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">CompactSketch</span> +<span class="extends-implements">extends <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span></div> +<div class="block">The parent class of all the CompactSketches. CompactSketches are never created directly. + They are created as a result of the compact() method of an UpdateSketch, a result of a + getResult() of a SetOperation, or from a heapify method. + + <p>A CompactSketch is the simplest form of a Theta Sketch. It consists of a compact list + (i.e., no intervening spaces) of hash values, which may be ordered or not, a value for theta + and a seed hash. A CompactSketch is immutable (read-only), + and the space required when stored is only the space required for the hash values and 8 to 24 + bytes of preamble. An empty CompactSketch consumes only 8 bytes.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CompactSketch</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Convert this sketch to a <i>CompactSketch</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompactBytes()" class="member-name-link">getCompactBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of storage bytes required for this Sketch if its current state were + compacted.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Family that this sketch belongs to</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCompact()" class="member-name-link">isCompact</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is in compact form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArrayCompressed()" class="member-name-link">toByteArrayCompressed</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">gets the sketch as a compressed byte array</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the CompactSketch image in given Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.theta.Sketch">Methods inherited from class org.apache.datasketches.theta.<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></h3> +<code><a href="Sketch.html#compact()">compact</a>, <a href="Sketch.html#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes</a>, <a href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a>, <a href="Sketch.html#getCurrentBytes()">getCurrentBytes</a>, <a href="Sketch.html#getEstimate()">getEstimate</a>, <a href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="Sketch.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes</a>, <a href="Sketch.html#getMaxUpdateSketchBytes(int)">getMaxUpdateSketchBytes</a>, <a href="Sketch.html#getRetainedEntries()">getRetainedEntries</a>, <a href="Sketch.html#getRetainedEntries(boolean)">getRetainedEntries</a>, <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)">getSerializationVersion</a>, <a href="Sketch.html#getTheta()">getTheta</a>, <a href="Sketch.html#getThetaLong()">getThetaLong</a>, <a href="Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="Sketch.html#isEmpty()">isEmpty</a>, <a href="Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="Sketch.html#isOrdered()">isOrdered</a>, <a href="Sketch.html#iterator()">iterator</a>, <a href="Sketch.html#toByteArray()">toByteArray</a>, <a href="Sketch.html#toString()">toString</a>, <a href="Sketch.html#toString(boolean,boolean,int,boolean)">toString</a>, <a href="Sketch.html#toString(byte%5B%5D)">toString</a>, <a href="Sketch.html#toString(org.apache.datasketches.memory.Memory)">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.MemoryStatus">Methods inherited from interface org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></h3> +<code><a href="../common/MemoryStatus.html#hasMemory()">hasMemory</a>, <a href="../common/MemoryStatus.html#isDirect()">isDirect</a>, <a href="../common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>CompactSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CompactSketch</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch. + + <p>The resulting sketch will not retain any link to the source Memory and all of its data will be + copied to the heap CompactSketch.</p> + + <p>This method assumes that the sketch image was created with the correct hash seed, so it is not checked. + The resulting on-heap CompactSketch will be given the seedHash derived from the given sketch image. + However, Serial Version 1 sketch images do not have a seedHash field, + so the resulting heapified CompactSketch will be given the hash of the DEFAULT_UPDATE_SEED.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a CompactSketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd> +<dt>Returns:</dt> +<dd>a CompactSketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch. + + <p>The resulting sketch will not retain any link to the source Memory and all of its data will be + copied to the heap CompactSketch.</p> + + <p>This method checks if the given expectedSeed was used to create the source Memory image. + However, SerialVersion 1 sketch images cannot be checked as they don't have a seedHash field, + so the resulting heapified CompactSketch will be given the hash of the expectedSeed.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a CompactSketch that was created using the given expectedSeed. + <a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd> +<dt>Returns:</dt> +<dd>a CompactSketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap takes the CompactSketch image in given Memory and refers to it directly. + There is no data copying onto the java heap. + The wrap operation enables fast read-only merging and access to all the public read-only API. + + <p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have + been explicitly stored as direct sketches can be wrapped. + Wrapping earlier serial version sketches will result in a heapify operation. + These early versions were never designed to "wrap".</p> + + <p>Wrapping any subclass of this class that is empty or contains only a single item will + result in heapified forms of empty and single item sketch respectively. + This is actually faster and consumes less overall memory.</p> + + <p>This method assumes that the sketch image was created with the correct hash seed, so it is not checked. + However, Serial Version 1 sketch images do not have a seedHash field, + so the resulting on-heap CompactSketch will be given the hash of the DEFAULT_UPDATE_SEED.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd> +<dt>Returns:</dt> +<dd>a CompactSketch backed by the given Memory except as above.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly. + There is no data copying onto the java heap. + The wrap operation enables fast read-only merging and access to all the public read-only API. + + <p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have + been explicitly stored as direct sketches can be wrapped. + Wrapping earlier serial version sketches will result in a heapify operation. + These early versions were never designed to "wrap".</p> + + <p>Wrapping any subclass of this class that is empty or contains only a single item will + result in heapified forms of empty and single item sketch respectively. + This is actually faster and consumes less overall memory.</p> + + <p>This method checks if the given expectedSeed was used to create the source Memory image. + However, SerialVersion 1 sketches cannot be checked as they don't have a seedHash field, + so the resulting heapified CompactSketch will be given the hash of the expectedSeed.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch that was created using the given expectedSeed. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd> +<dt>Returns:</dt> +<dd>a CompactSketch backed by the given Memory except as above.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact(boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">compact</span><wbr><span class="parameters">(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)">Sketch</a></code></span></div> +<div class="block">Convert this sketch to a <i>CompactSketch</i>. + + <p>If this sketch is a type of <i>UpdateSketch</i>, the compacting process converts the hash table + of the <i>UpdateSketch</i> to a simple list of the valid hash values. + Any hash values of zero or equal-to or greater than theta will be discarded. + The number of valid values remaining in the <i>CompactSketch</i> depends on a number of factors, + but may be larger or smaller than <i>Nominal Entries</i> (or <i>k</i>). + It will never exceed 2<i>k</i>. + If it is critical to always limit the size to no more than <i>k</i>, + then <i>rebuild()</i> should be called on the <i>UpdateSketch</i> prior to calling this method.</p> + + <p>A <i>CompactSketch</i> is always immutable.</p> + + <p>A new <i>CompactSketch</i> object is created:</p> + <ul><li>if <i>dstMem != null</i></li> + <li>if <i>dstMem == null</i> and <i>this.hasMemory() == true</i></li> + <li>if <i>dstMem == null</i> and <i>this</i> has more than 1 item and <i>this.isOrdered() == false</i> + and <i>dstOrdered == true</i>.</li> +</ul> + + <p>Otherwise, this operation returns <i>this</i>.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)">compact</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>dstOrdered</code> - assumed true if this sketch is empty or has only one value + <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a></dd> +<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dt>Returns:</dt> +<dd>this sketch as a <i>CompactSketch</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactBytes()"> +<h3>getCompactBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCompactBytes</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#getCompactBytes()">Sketch</a></code></span></div> +<div class="block">Returns the number of storage bytes required for this Sketch if its current state were + compacted. It this sketch is already in the compact form this is equivalent to + calling <a href="Sketch.html#getCurrentBytes()"><code>Sketch.getCurrentBytes()</code></a>.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#getCompactBytes()">getCompactBytes</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Returns:</dt> +<dd>number of compact bytes</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#getFamily()">Sketch</a></code></span></div> +<div class="block">Returns the Family that this sketch belongs to</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#getFamily()">getFamily</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Returns:</dt> +<dd>the Family that this sketch belongs to</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isCompact()"> +<h3>isCompact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCompact</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#isCompact()">Sketch</a></code></span></div> +<div class="block">Returns true if this sketch is in compact form.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#isCompact()">isCompact</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is in compact form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArrayCompressed()"> +<h3>toByteArrayCompressed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArrayCompressed</span>()</div> +<div class="block">gets the sketch as a compressed byte array</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sketch as a compressed byte array</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/HashIterator.html b/docs/7.0.X/org/apache/datasketches/theta/HashIterator.html new file mode 100644 index 000000000..3d1a5de51 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/HashIterator.html @@ -0,0 +1,158 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>HashIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, interface: HashIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/HashIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Interface HashIterator" class="title">Interface HashIterator</h1> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">HashIterator</span></div> +<div class="block">This is used to iterate over the retained hash values of the Theta sketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#get()" class="member-name-link">get</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the hash value</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true at the next hash value in sequence.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="get()"> +<h3>get</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">get</span>()</div> +<div class="block">Gets the hash value</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the hash value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block">Returns true at the next hash value in sequence. + If false, the iteration is done.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true at the next hash value in sequence.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/Intersection.html b/docs/7.0.X/org/apache/datasketches/theta/Intersection.html new file mode 100644 index 000000000..a4e1956c2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/Intersection.html @@ -0,0 +1,360 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Intersection (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: Intersection"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Intersection.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class Intersection" class="title">Class Intersection</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">org.apache.datasketches.theta.SetOperation</a> +<div class="inheritance">org.apache.datasketches.theta.Intersection</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Intersection</span> +<span class="extends-implements">extends <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span></div> +<div class="block">The API for intersection operations</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Intersection</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Family of this SetOperation</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of this operation as a CompactSketch in the given dstMem.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasResult()" class="member-name-link">hasResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if there is a valid intersection result available</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#intersect(org.apache.datasketches.theta.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Intersect the given sketch with the internal state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Perform intersect set operation on the two given sketch arguments and return the result as an + ordered CompactSketch on the heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">intersect</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Perform intersect set operation on the two given sketches and return the result as a + CompactSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Resets this Intersection for stateful operations only.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Serialize this intersection to a byte array form.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.theta.SetOperation">Methods inherited from class org.apache.datasketches.theta.<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></h3> +<code><a href="SetOperation.html#builder()">builder</a>, <a href="SetOperation.html#getMaxAnotBResultBytes(int)">getMaxAnotBResultBytes</a>, <a href="SetOperation.html#getMaxIntersectionBytes(int)">getMaxIntersectionBytes</a>, <a href="SetOperation.html#getMaxUnionBytes(int)">getMaxUnionBytes</a>, <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)">heapify</a>, <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)">heapify</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory,long)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.MemoryStatus">Methods inherited from interface org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></h3> +<code><a href="../common/MemoryStatus.html#hasMemory()">hasMemory</a>, <a href="../common/MemoryStatus.html#isDirect()">isDirect</a>, <a href="../common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>Intersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Intersection</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SetOperation.html#getFamily()">SetOperation</a></code></span></div> +<div class="block">Gets the Family of this SetOperation</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SetOperation.html#getFamily()">getFamily</a></code> in class <code><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></dd> +<dt>Returns:</dt> +<dd>the Family of this SetOperation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap. + This does not disturb the underlying data structure of this intersection. + The <a href="#intersect(org.apache.datasketches.theta.Sketch)"><code>intersect(Sketch)</code></a> method must have been called at least once, otherwise an + exception will be thrown. This is because a virgin Intersection object represents the + Universal Set, which has an infinite number of values.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of this operation as an ordered CompactSketch on the Java heap</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Gets the result of this operation as a CompactSketch in the given dstMem. + This does not disturb the underlying data structure of this intersection. + The <a href="#intersect(org.apache.datasketches.theta.Sketch)"><code>intersect(Sketch)</code></a> method must have been called at least once, otherwise an + exception will be thrown. This is because a virgin Intersection object represents the + Universal Set, which has an infinite number of values. + + <p>Note that presenting an intersection with an empty sketch sets the internal + state of the intersection to empty = true, and current count = 0. This is consistent with + the mathematical definition of the intersection of any set with the empty set is + always empty.</p> + + <p>Presenting an intersection with a null argument will throw an exception.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstOrdered</code> - <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a></dd> +<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dt>Returns:</dt> +<dd>the result of this operation as a CompactSketch stored in the given dstMem, + which can be either on or off-heap..</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasResult()"> +<h3>hasResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">hasResult</span>()</div> +<div class="block">Returns true if there is a valid intersection result available</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if there is a valid intersection result available</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this Intersection for stateful operations only. + The seed remains intact, otherwise reverts to + the Universal Set: theta = 1.0, no retained data and empty = false.</div> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Serialize this intersection to a byte array form.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>byte array of this intersection</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersect(org.apache.datasketches.theta.Sketch)"> +<h3>intersect</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</span></div> +<div class="block">Intersect the given sketch with the internal state. + This method can be repeatedly called. + If the given sketch is null the internal state becomes the empty sketch. + Theta will become the minimum of thetas seen so far.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - the given sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>intersect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b)</span></div> +<div class="block">Perform intersect set operation on the two given sketch arguments and return the result as an + ordered CompactSketch on the heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - The first sketch argument</dd> +<dd><code>b</code> - The second sketch argument</dd> +<dt>Returns:</dt> +<dd>an ordered CompactSketch on the heap</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>intersect</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Perform intersect set operation on the two given sketches and return the result as a + CompactSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - The first sketch argument</dd> +<dd><code>b</code> - The second sketch argument</dd> +<dd><code>dstOrdered</code> - <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a>.</dd> +<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dt>Returns:</dt> +<dd>the result as a CompactSketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/JaccardSimilarity.html b/docs/7.0.X/org/apache/datasketches/theta/JaccardSimilarity.html new file mode 100644 index 000000000..8e2320b37 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/JaccardSimilarity.html @@ -0,0 +1,270 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>JaccardSimilarity (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: JaccardSimilarity"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/JaccardSimilarity.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class JaccardSimilarity" class="title">Class JaccardSimilarity</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.theta.JaccardSimilarity</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">JaccardSimilarity</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Jaccard similarity of two Theta Sketches.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JaccardSimilarity</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#dissimilarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + double threshold)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#exactlyEqual(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">exactlyEqual</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#jaccard(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">jaccard</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#similarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)" class="member-name-link">similarityTest</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + double threshold)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>JaccardSimilarity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JaccardSimilarity</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="jaccard(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>jaccard</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double[]</span> <span class="element-name">jaccard</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds. The Jaccard similarity index + <i>J(A,B) = (A ^ B)/(A U B)</i> is used to measure how similar the two sketches are to each + other. If J = 1.0, the sketches are considered equal. If J = 0, the two sketches are + distinct from each other. A Jaccard of .95 means the overlap between the two + populations is 95% of the union of the two populations. + + <p>Note: For very large pairs of sketches, where the configured nominal entries of the sketches + are 2^25 or 2^26, this method may produce unpredictable results.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - given sketch A</dd> +<dd><code>sketchB</code> - given sketch B</dd> +<dt>Returns:</dt> +<dd>a double array {LowerBound, Estimate, UpperBound} of the Jaccard index. + The Upper and Lower bounds are for a confidence interval of 95.4% or +/- 2 standard deviations.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="exactlyEqual(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>exactlyEqual</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">exactlyEqual</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values. Thus, they are equivalent.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the given sketch A</dd> +<dd><code>sketchB</code> - the given sketch B</dd> +<dt>Returns:</dt> +<dd>true if the two given sketches have exactly the same hash values and the same + theta values.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="similarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)"> +<h3>similarityTest</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">similarityTest</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + double threshold)</span></div> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch. + Computes the lower bound of the Jaccard index <i>J<sub>LB</sub></i> of the measured and + expected sketches. + if <i>J<sub>LB</sub> ≥ threshold</i>, then the sketches are considered to be + similar with a confidence of 97.7%.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>measured</code> - the sketch to be tested</dd> +<dd><code>expected</code> - the reference sketch that is considered to be correct.</dd> +<dd><code>threshold</code> - a real value between zero and one.</dd> +<dt>Returns:</dt> +<dd>if true, the similarity of the two sketches is greater than the given threshold + with at least 97.7% confidence.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="dissimilarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)"> +<h3>dissimilarityTest</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">dissimilarityTest</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + double threshold)</span></div> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch. + Computes the upper bound of the Jaccard index <i>J<sub>UB</sub></i> of the measured and + expected sketches. + if <i>J<sub>UB</sub> ≤ threshold</i>, then the sketches are considered to be + dissimilar with a confidence of 97.7%.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>measured</code> - the sketch to be tested</dd> +<dd><code>expected</code> - the reference sketch that is considered to be correct.</dd> +<dd><code>threshold</code> - a real value between zero and one.</dd> +<dt>Returns:</dt> +<dd>if true, the dissimilarity of the two sketches is greater than the given threshold + with at least 97.7% confidence.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/SetOperation.html b/docs/7.0.X/org/apache/datasketches/theta/SetOperation.html new file mode 100644 index 000000000..2d986aac0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/SetOperation.html @@ -0,0 +1,396 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SetOperation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: SetOperation"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SetOperation.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class SetOperation" class="title">Class SetOperation</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.theta.SetOperation</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></code></dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></code>, <code><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code>, <code><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">SetOperation</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></span></div> +<div class="block">The parent API for all Set Operations</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Makes a new builder</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the Family of this SetOperation</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxAnotBResultBytes(int)" class="member-name-link">getMaxAnotBResultBytes</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum number of bytes for the returned CompactSketch, given the + value of nomEntries of the first sketch A of AnotB.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxIntersectionBytes(int)" class="member-name-link">getMaxIntersectionBytes</a><wbr>(int nomEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum required storage bytes given a nomEntries parameter for Intersection + operations</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxUnionBytes(int)" class="member-name-link">getMaxUnionBytes</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum required storage bytes given a nomEntries parameter for Union operations</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify takes the SetOperations image in Memory and instantiates an on-heap + SetOperation using the + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify takes the SetOperation image in Memory and instantiates an on-heap + SetOperation using the given expectedSeed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.MemoryStatus">Methods inherited from interface org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></h3> +<code><a href="../common/MemoryStatus.html#hasMemory()">hasMemory</a>, <a href="../common/MemoryStatus.html#isDirect()">isDirect</a>, <a href="../common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="builder()"> +<h3>builder</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">builder</span>()</div> +<div class="block">Makes a new builder</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a new builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify takes the SetOperations image in Memory and instantiates an on-heap + SetOperation using the + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>. + The resulting SetOperation will not retain any link to the source Memory. + + <p>Note: Only certain set operators during stateful operations can be serialized and thus + heapified.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a SetOperation where the image seed hash matches the default seed hash. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a Heap-based SetOperation from the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Heapify takes the SetOperation image in Memory and instantiates an on-heap + SetOperation using the given expectedSeed. + The resulting SetOperation will not retain any link to the source Memory. + + <p>Note: Only certain set operators during stateful operations can be serialized and thus + heapified.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a SetOperation where the hash of the given expectedSeed matches the image seed hash. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd> +<dt>Returns:</dt> +<dd>a Heap-based SetOperation from the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly. + There is no data copying onto the java heap. + This method assumes the + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>. + + <p>Note: Only certain set operators during stateful operations can be serialized and thus + wrapped.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a SetOperation where the image seed hash matches the default seed hash. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a SetOperation backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly. + There is no data copying onto the java heap. + + <p>Note: Only certain set operators during stateful operations can be serialized and thus + wrapped.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a SetOperation where the hash of the given expectedSeed matches the image seed hash. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd> +<dt>Returns:</dt> +<dd>a SetOperation backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly. + There is no data copying onto the java heap. + This method assumes the + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>. + + <p>Note: Only certain set operators during stateful operations can be serialized and thus + wrapped.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a SetOperation where the image seed hash matches the default seed hash. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a SetOperation backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</span></div> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly. + There is no data copying onto the java heap. + + <p>Note: Only certain set operators during stateful operations can be serialized and thus + wrapped.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a SetOperation where the hash of the given expectedSeed matches the image seed hash. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd> +<dt>Returns:</dt> +<dd>a SetOperation backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxUnionBytes(int)"> +<h3>getMaxUnionBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxUnionBytes</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Returns the maximum required storage bytes given a nomEntries parameter for Union operations</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a> + This will become the ceiling power of 2 if it is not.</dd> +<dt>Returns:</dt> +<dd>the maximum required storage bytes given a nomEntries parameter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxIntersectionBytes(int)"> +<h3>getMaxIntersectionBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxIntersectionBytes</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Returns the maximum required storage bytes given a nomEntries parameter for Intersection + operations</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a> + This will become the ceiling power of 2 if it is not.</dd> +<dt>Returns:</dt> +<dd>the maximum required storage bytes given a nomEntries parameter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxAnotBResultBytes(int)"> +<h3>getMaxAnotBResultBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxAnotBResultBytes</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Returns the maximum number of bytes for the returned CompactSketch, given the + value of nomEntries of the first sketch A of AnotB.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - this value must be a power of 2.</dd> +<dt>Returns:</dt> +<dd>the maximum number of bytes.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block">Gets the Family of this SetOperation</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Family of this SetOperation</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/SetOperationBuilder.html b/docs/7.0.X/org/apache/datasketches/theta/SetOperationBuilder.html new file mode 100644 index 000000000..720389ddc --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/SetOperationBuilder.html @@ -0,0 +1,518 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SetOperationBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: SetOperationBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SetOperationBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class SetOperationBuilder" class="title">Class SetOperationBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.theta.SetOperationBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SetOperationBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">For building a new SetOperation.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SetOperationBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor for building a new SetOperation.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build(org.apache.datasketches.common.Family)" class="member-name-link">build</a><wbr>(<a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(<a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family + and the given destination memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildANotB()" class="member-name-link">buildANotB</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Convenience method, returns a configured SetOperation ANotB with + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildIntersection()" class="member-name-link">buildIntersection</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildIntersection</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildUnion()" class="member-name-link">buildUnion</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgNominalEntries()" class="member-name-link">getLgNominalEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns Log-base 2 Nominal Entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.datasketches.memory.MemoryRequestServer</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMemoryRequestServer()" class="member-name-link">getMemoryRequestServer</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the MemoryRequestServer</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getP()" class="member-name-link">getP</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the pre-sampling probability <i>p</i></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Resize Factor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSeed()" class="member-name-link">getSeed</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the seed</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLogNominalEntries(int)" class="member-name-link">setLogNominalEntries</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Alternative method of setting the Nominal Entries for this set operation from the log_base2 value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">setMemoryRequestServer</a><wbr>(org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Set the MemoryRequestServer</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the Maximum Nominal Entries (max K) for this set operation.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setP(float)" class="member-name-link">setP</a><wbr>(float p)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the cache Resize Factor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the long seed value that is require by the hashing function.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>SetOperationBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SetOperationBuilder</span>()</div> +<div class="block">Constructor for building a new SetOperation. The default configuration is + <ul> + <li>Max Nominal Entries (max K): + <a href="../thetacommon/ThetaUtil.html#DEFAULT_NOMINAL_ENTRIES">4096</a></li> + <li>Seed: <a href="../thetacommon/ThetaUtil.html#DEFAULT_UPDATE_SEED">9001L</a></li> + <li><a href="../common/ResizeFactor.html#X8"><code>ResizeFactor.X8</code></a></li> + <li>Input Sampling Probability: 1.0</li> + <li>Memory: null</li> + </ul></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setNominalEntries(int)"> +<h3>setNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">setNominalEntries</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Sets the Maximum Nominal Entries (max K) for this set operation. The effective value of K of the result of a + Set Operation can be less than max K, but never greater. + The minimum value is 16 and the maximum value is 67,108,864, which is 2^26.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a> + This will become the ceiling power of 2 if it is not a power of 2.</dd> +<dt>Returns:</dt> +<dd>this SetOperationBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setLogNominalEntries(int)"> +<h3>setLogNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">setLogNominalEntries</span><wbr><span class="parameters">(int lgNomEntries)</span></div> +<div class="block">Alternative method of setting the Nominal Entries for this set operation from the log_base2 value. + The minimum value is 4 and the maximum value is 26. + Be aware that set operations as large as this maximum value may not have been + thoroughly characterized for performance.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgNomEntries</code> - the log_base2 Nominal Entries.</dd> +<dt>Returns:</dt> +<dd>this SetOperationBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgNominalEntries()"> +<h3>getLgNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgNominalEntries</span>()</div> +<div class="block">Returns Log-base 2 Nominal Entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Log-base 2 Nominal Entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setSeed(long)"> +<h3>setSeed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">setSeed</span><wbr><span class="parameters">(long seed)</span></div> +<div class="block">Sets the long seed value that is require by the hashing function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seed</code> - <a href="../../../../resources/dictionary.html#seed">See seed</a></dd> +<dt>Returns:</dt> +<dd>this SetOperationBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSeed()"> +<h3>getSeed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getSeed</span>()</div> +<div class="block">Returns the seed</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the seed</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setP(float)"> +<h3>setP</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">setP</span><wbr><span class="parameters">(float p)</span></div> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i>. Although this functionality is + implemented for Unions only, it rarely makes sense to use it. The proper use of upfront + sampling is when building the sketches.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>p</code> - <a href="../../../../resources/dictionary.html#p">See Sampling Probability, <i>p</i></a></dd> +<dt>Returns:</dt> +<dd>this SetOperationBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getP()"> +<h3>getP</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getP</span>()</div> +<div class="block">Returns the pre-sampling probability <i>p</i></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the pre-sampling probability <i>p</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setResizeFactor(org.apache.datasketches.common.ResizeFactor)"> +<h3>setResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">setResizeFactor</span><wbr><span class="parameters">(<a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</span></div> +<div class="block">Sets the cache Resize Factor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rf</code> - <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> +<dt>Returns:</dt> +<dd>this SetOperationBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Returns the Resize Factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Resize Factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>setMemoryRequestServer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">setMemoryRequestServer</span><wbr><span class="parameters">(org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Set the MemoryRequestServer</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>memReqSvr</code> - the given MemoryRequestServer</dd> +<dt>Returns:</dt> +<dd>this SetOperationBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMemoryRequestServer()"> +<h3>getMemoryRequestServer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.datasketches.memory.MemoryRequestServer</span> <span class="element-name">getMemoryRequestServer</span>()</div> +<div class="block">Returns the MemoryRequestServer</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the MemoryRequestServer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build(org.apache.datasketches.common.Family)"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">build</span><wbr><span class="parameters">(<a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</span></div> +<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>family</code> - the chosen SetOperation family</dd> +<dt>Returns:</dt> +<dd>a SetOperation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">build</span><wbr><span class="parameters">(<a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family + and the given destination memory. Note that the destination memory cannot be used with AnotB.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>family</code> - the chosen SetOperation family</dd> +<dd><code>dstMem</code> - The destination Memory.</dd> +<dt>Returns:</dt> +<dd>a SetOperation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildUnion()"> +<h3>buildUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></span> <span class="element-name">buildUnion</span>()</div> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a Union object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildUnion(org.apache.datasketches.memory.WritableMemory)"> +<h3>buildUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></span> <span class="element-name">buildUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - The destination Memory.</dd> +<dt>Returns:</dt> +<dd>a Union object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildIntersection()"> +<h3>buildIntersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></span> <span class="element-name">buildIntersection</span>()</div> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an Intersection object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildIntersection(org.apache.datasketches.memory.WritableMemory)"> +<h3>buildIntersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></span> <span class="element-name">buildIntersection</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - The destination Memory.</dd> +<dt>Returns:</dt> +<dd>an Intersection object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildANotB()"> +<h3>buildANotB</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></span> <span class="element-name">buildANotB</span>()</div> +<div class="block">Convenience method, returns a configured SetOperation ANotB with + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an ANotB object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/Sketch.html b/docs/7.0.X/org/apache/datasketches/theta/Sketch.html new file mode 100644 index 000000000..18f4d9d22 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/Sketch.html @@ -0,0 +1,801 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Sketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: Sketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Sketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class Sketch" class="title">Class Sketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.theta.Sketch</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></code></dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code>, <code><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Sketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></span></div> +<div class="block">The top-level class for all theta sketches. This class is never constructed directly. + Use the UpdateSketch.builder() methods to create UpdateSketches.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Converts this sketch to a ordered CompactSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Convert this sketch to a <i>CompactSketch</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCompactBytes()" class="member-name-link">getCompactBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the number of storage bytes required for this Sketch if its current state were + compacted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCompactSketchMaxBytes(int)" class="member-name-link">getCompactSketchMaxBytes</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured + log_base2 of the number of nominal entries, which is a power of 2.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCurrentBytes()" class="member-name-link">getCurrentBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the number of storage bytes required for this sketch in its current state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the unique count estimate.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the Family that this sketch belongs to</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int)" class="member-name-link">getLowerBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxCompactSketchBytes(int)" class="member-name-link">getMaxCompactSketchBytes</a><wbr>(int numberOfEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given + number of actual entries.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxUpdateSketchBytes(int)" class="member-name-link">getMaxUpdateSketchBytes</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum number of storage bytes required for an UpdateSketch with the given + number of nominal entries (power of 2).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of valid entries that have been retained by the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRetainedEntries(boolean)" class="member-name-link">getRetainedEntries</a><wbr>(boolean valid)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the number of entries that have been retained by the sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializationVersion(org.apache.datasketches.memory.Memory)" class="member-name-link">getSerializationVersion</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the serialization version from the given Memory</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTheta()" class="member-name-link">getTheta</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the value of theta as a double with a value between zero and one</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getThetaLong()" class="member-name-link">getThetaLong</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the value of theta as a long</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int)" class="member-name-link">getUpperBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isCompact()" class="member-name-link">isCompact</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch is in compact form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isOrdered()" class="member-name-link">isOrdered</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if internal cache is ordered</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a HashIterator that can be used to iterate over the retained hash values of the + Theta sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Serialize this sketch to a byte array form.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a human readable summary of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(boolean,boolean,int,boolean)" class="member-name-link">toString</a><wbr>(boolean sketchSummary, + boolean dataDetail, + int width, + boolean hexMode)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets a human readable listing of contents and summary of the given sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(byte%5B%5D)" class="member-name-link">toString</a><wbr>(byte[] byteArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a byte array image of a Theta Sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.apache.datasketches.memory.Memory)" class="member-name-link">toString</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a human readable string of the preamble of a Memory image of a Theta Sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.MemoryStatus">Methods inherited from interface org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></h3> +<code><a href="../common/MemoryStatus.html#hasMemory()">hasMemory</a>, <a href="../common/MemoryStatus.html#isDirect()">isDirect</a>, <a href="../common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch. + + <p>The resulting sketch will not retain any link to the source Memory.</p> + + <p>For Update Sketches this method checks if the + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></p> + was used to create the source Memory image. + + <p>For Compact Sketches this method assumes that the sketch image was created with the + correct hash seed, so it is not checked.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd> +<dt>Returns:</dt> +<dd>a Sketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch. + + <p>The resulting sketch will not retain any link to the source Memory.</p> + + <p>For Update and Compact Sketches this method checks if the given expectedSeed was used to + create the source Memory image. However, SerialVersion 1 sketches cannot be checked.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch that was created using the given expectedSeed. + <a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>. + Compact sketches store a 16-bit hash of the seed, but not the seed itself.</dd> +<dt>Returns:</dt> +<dd>a Sketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly. + There is no data copying onto the java heap. + The wrap operation enables fast read-only merging and access to all the public read-only API. + + <p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have + been explicitly stored as direct sketches can be wrapped. + Wrapping earlier serial version sketches will result in a on-heap CompactSketch + where all data will be copied to the heap. These early versions were never designed to + "wrap".</p> + + <p>Wrapping any subclass of this class that is empty or contains only a single item will + result in on-heap equivalent forms of empty and single item sketch respectively. + This is actually faster and consumes less overall memory.</p> + + <p>For Update Sketches this method checks if the + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></p> + was used to create the source Memory image. + + <p>For Compact Sketches this method assumes that the sketch image was created with the + correct hash seed, so it is not checked.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd> +<dt>Returns:</dt> +<dd>a Sketch backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly. + There is no data copying onto the java heap. + The wrap operation enables fast read-only merging and access to all the public read-only API. + + <p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have + been explicitly stored as direct sketches can be wrapped. + Wrapping earlier serial version sketches will result in a on-heap CompactSketch + where all data will be copied to the heap. These early versions were never designed to + "wrap".</p> + + <p>Wrapping any subclass of this class that is empty or contains only a single item will + result in on-heap equivalent forms of empty and single item sketch respectively. + This is actually faster and consumes less overall memory.</p> + + <p>For Update and Compact Sketches this method checks if the given expectedSeed was used to + create the source Memory image. However, SerialVersion 1 sketches cannot be checked.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd> +<dt>Returns:</dt> +<dd>a UpdateSketch backed by the given Memory except as above.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">compact</span>()</div> +<div class="block">Converts this sketch to a ordered CompactSketch. + + <p>If <i>this.isCompact() == true</i> this method returns <i>this</i>, + otherwise, this method is equivalent to + <a href="#compact(boolean,org.apache.datasketches.memory.WritableMemory)"><code>compact(true, null)</code></a>. + + <p>A CompactSketch is always immutable.</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch as an ordered CompactSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact(boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">compact</span><wbr><span class="parameters">(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Convert this sketch to a <i>CompactSketch</i>. + + <p>If this sketch is a type of <i>UpdateSketch</i>, the compacting process converts the hash table + of the <i>UpdateSketch</i> to a simple list of the valid hash values. + Any hash values of zero or equal-to or greater than theta will be discarded. + The number of valid values remaining in the <i>CompactSketch</i> depends on a number of factors, + but may be larger or smaller than <i>Nominal Entries</i> (or <i>k</i>). + It will never exceed 2<i>k</i>. + If it is critical to always limit the size to no more than <i>k</i>, + then <i>rebuild()</i> should be called on the <i>UpdateSketch</i> prior to calling this method.</p> + + <p>A <i>CompactSketch</i> is always immutable.</p> + + <p>A new <i>CompactSketch</i> object is created:</p> + <ul><li>if <i>dstMem != null</i></li> + <li>if <i>dstMem == null</i> and <i>this.hasMemory() == true</i></li> + <li>if <i>dstMem == null</i> and <i>this</i> has more than 1 item and <i>this.isOrdered() == false</i> + and <i>dstOrdered == true</i>.</li> +</ul> + + <p>Otherwise, this operation returns <i>this</i>.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstOrdered</code> - assumed true if this sketch is empty or has only one value + <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a></dd> +<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dt>Returns:</dt> +<dd>this sketch as a <i>CompactSketch</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactBytes()"> +<h3>getCompactBytes</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getCompactBytes</span>()</div> +<div class="block">Returns the number of storage bytes required for this Sketch if its current state were + compacted. It this sketch is already in the compact form this is equivalent to + calling <a href="#getCurrentBytes()"><code>getCurrentBytes()</code></a>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>number of compact bytes</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentBytes()"> +<h3>getCurrentBytes</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getCurrentBytes</span>()</div> +<div class="block">Returns the number of storage bytes required for this sketch in its current state.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of storage bytes required for this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<div class="block">Gets the unique count estimate.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the sketch's best estimate of the cardinality of the input stream.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block">Returns the Family that this sketch belongs to</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Family that this sketch belongs to</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the lower bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxCompactSketchBytes(int)"> +<h3>getMaxCompactSketchBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxCompactSketchBytes</span><wbr><span class="parameters">(int numberOfEntries)</span></div> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given + number of actual entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numberOfEntries</code> - the actual number of retained entries stored in the sketch.</dd> +<dt>Returns:</dt> +<dd>the maximum number of storage bytes required for a CompactSketch with the given number + of retained entries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactSketchMaxBytes(int)"> +<h3>getCompactSketchMaxBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getCompactSketchMaxBytes</span><wbr><span class="parameters">(int lgNomEntries)</span></div> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured + log_base2 of the number of nominal entries, which is a power of 2.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgNomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a></dd> +<dt>Returns:</dt> +<dd>the maximum number of storage bytes required for a CompactSketch with the given + lgNomEntries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxUpdateSketchBytes(int)"> +<h3>getMaxUpdateSketchBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxUpdateSketchBytes</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Returns the maximum number of storage bytes required for an UpdateSketch with the given + number of nominal entries (power of 2).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a> + This will become the ceiling power of 2 if it is not.</dd> +<dt>Returns:</dt> +<dd>the maximum number of storage bytes required for a UpdateSketch with the given + nomEntries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<div class="block">Returns the number of valid entries that have been retained by the sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of valid retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries(boolean)"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span><wbr><span class="parameters">(boolean valid)</span></div> +<div class="block">Returns the number of entries that have been retained by the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>valid</code> - if true, returns the number of valid entries, which are less than theta and used + for estimation. + Otherwise, return the number of all entries, valid or not, that are currently in the internal + sketch cache.</dd> +<dt>Returns:</dt> +<dd>the number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializationVersion(org.apache.datasketches.memory.Memory)"> +<h3>getSerializationVersion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getSerializationVersion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns the serialization version from the given Memory</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the sketch Memory</dd> +<dt>Returns:</dt> +<dd>the serialization version from the Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getTheta()"> +<h3>getTheta</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getTheta</span>()</div> +<div class="block">Gets the value of theta as a double with a value between zero and one</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the value of theta as a double</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getThetaLong()"> +<h3>getThetaLong</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">long</span> <span class="element-name">getThetaLong</span>()</div> +<div class="block">Gets the value of theta as a long</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the value of theta as a long</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the upper bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isCompact()"> +<h3>isCompact</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isCompact</span>()</div> +<div class="block">Returns true if this sketch is in compact form.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch is in compact form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode). + This is true if theta < 1.0 AND isEmpty() is false.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isOrdered()"> +<h3>isOrdered</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isOrdered</span>()</div> +<div class="block">Returns true if internal cache is ordered</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if internal cache is ordered</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></span> <span class="element-name">iterator</span>()</div> +<div class="block">Returns a HashIterator that can be used to iterate over the retained hash values of the + Theta sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a HashIterator that can be used to iterate over the retained hash values of the + Theta sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Serialize this sketch to a byte array form.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>byte array of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<div class="block">Returns a human readable summary of the sketch. This method is equivalent to the parameterized + call:<br> + <i>Sketch.toString(sketch, true, false, 8, true);</i></div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +<dt>Returns:</dt> +<dd>summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(boolean,boolean,int,boolean)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(boolean sketchSummary, + boolean dataDetail, + int width, + boolean hexMode)</span></div> +<div class="block">Gets a human readable listing of contents and summary of the given sketch. + This can be a very long string. If this sketch is in a "dirty" state there + may be values in the dataDetail view that are ≥ theta.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchSummary</code> - If true the sketch summary will be output at the end.</dd> +<dd><code>dataDetail</code> - If true, includes all valid hash values in the sketch.</dd> +<dd><code>width</code> - The number of columns of hash values. Default is 8.</dd> +<dd><code>hexMode</code> - If true, hashes will be output in hex.</dd> +<dt>Returns:</dt> +<dd>The result string, which can be very long.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(byte[])"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(byte[] byteArr)</span></div> +<div class="block">Returns a human readable string of the preamble of a byte array image of a Theta Sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>byteArr</code> - the given byte array</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a byte array image of a Theta Sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString(org.apache.datasketches.memory.Memory)"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Returns a human readable string of the preamble of a Memory image of a Theta Sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory object</dd> +<dt>Returns:</dt> +<dd>a human readable string of the preamble of a Memory image of a Theta Sketch.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/Sketches.html b/docs/7.0.X/org/apache/datasketches/theta/Sketches.html new file mode 100644 index 000000000..46d824de4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/Sketches.html @@ -0,0 +1,811 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Sketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: Sketches"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Sketches.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class Sketches" class="title">Class Sketches</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.theta.Sketches</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Sketches</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class brings together the common sketch and set operation creation methods and + the public static methods into one place.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCompactSketchMaxBytes(int)" class="member-name-link">getCompactSketchMaxBytes</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured + log_base2 of the number of nominal entries, which is a power of 2.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimate(org.apache.datasketches.memory.Memory)" class="member-name-link">getEstimate</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the unique count estimate from a valid memory image of a Sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLowerBound(int,org.apache.datasketches.memory.Memory)" class="member-name-link">getLowerBound</a><wbr>(int numStdDev, + org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate lower error bound from a valid memory image of a Sketch + given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxAnotBResultBytes(int)" class="member-name-link">getMaxAnotBResultBytes</a><wbr>(int maxNomEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#getMaxAnotBResultBytes(int)"><code>SetOperation.getMaxAnotBResultBytes(int)</code></a>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxCompactSketchBytes(int)" class="member-name-link">getMaxCompactSketchBytes</a><wbr>(int numberOfEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given + number of actual entries.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxIntersectionBytes(int)" class="member-name-link">getMaxIntersectionBytes</a><wbr>(int nomEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxUnionBytes(int)" class="member-name-link">getMaxUnionBytes</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxUpdateSketchBytes(int)" class="member-name-link">getMaxUpdateSketchBytes</a><wbr>(int nomEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSerializationVersion(org.apache.datasketches.memory.Memory)" class="member-name-link">getSerializationVersion</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpperBound(int,org.apache.datasketches.memory.Memory)" class="member-name-link">getUpperBound</a><wbr>(int numStdDev, + org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate upper error bound from a valid memory image of a Sketch + given the specified number of Standard Deviations.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyCompactSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyCompactSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifySetOperation(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifySetOperation(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifySketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifySketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyUpdateSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUpdateSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyUpdateSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUpdateSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setOperationBuilder()" class="member-name-link">setOperationBuilder</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#updateSketchBuilder()" class="member-name-link">updateSketchBuilder</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapCompactSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapCompactSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapIntersection(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapIntersection</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapIntersection</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSetOperation(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSetOperation(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSetOperation(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSetOperation(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUpdateSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUpdateSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a></div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getEstimate(org.apache.datasketches.memory.Memory)"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Gets the unique count estimate from a valid memory image of a Sketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>the sketch's best estimate of the cardinality of the input stream.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int,org.apache.datasketches.memory.Memory)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int numStdDev, + org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Gets the approximate lower error bound from a valid memory image of a Sketch + given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>the lower bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxAnotBResultBytes(int)"> +<h3>getMaxAnotBResultBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxAnotBResultBytes</span><wbr><span class="parameters">(int maxNomEntries)</span></div> +<div class="block">Ref: <a href="SetOperation.html#getMaxAnotBResultBytes(int)"><code>SetOperation.getMaxAnotBResultBytes(int)</code></a>. + Returns the maximum number of bytes for the returned CompactSketch, given the maximum + value of nomEntries of the first sketch A of AnotB.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxNomEntries</code> - the given value</dd> +<dt>Returns:</dt> +<dd>the maximum number of bytes.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxCompactSketchBytes(int)"> +<h3>getMaxCompactSketchBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxCompactSketchBytes</span><wbr><span class="parameters">(int numberOfEntries)</span></div> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given + number of actual entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numberOfEntries</code> - the actual number of retained entries stored in the sketch.</dd> +<dt>Returns:</dt> +<dd>the maximum number of storage bytes required for a CompactSketch with the given number + of retained entries.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactSketchMaxBytes(int)"> +<h3>getCompactSketchMaxBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getCompactSketchMaxBytes</span><wbr><span class="parameters">(int lgNomEntries)</span></div> +<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured + log_base2 of the number of nominal entries, which is a power of 2.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgNomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a></dd> +<dt>Returns:</dt> +<dd>the maximum number of storage bytes required for a CompactSketch with the given + lgNomEntries.</dd> +<dt>See Also:</dt> +<dd> +<ul class="see-list-long"> +<li><a href="Sketch.html#getCompactSketchMaxBytes(int)"><code>Sketch.getCompactSketchMaxBytes(int)</code></a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxIntersectionBytes(int)"> +<h3>getMaxIntersectionBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxIntersectionBytes</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a>, <code>nomEntries</code></dd> +<dt>Returns:</dt> +<dd>Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxUnionBytes(int)"> +<h3>getMaxUnionBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxUnionBytes</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a>, <code>nomEntries</code></dd> +<dt>Returns:</dt> +<dd>Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxUpdateSketchBytes(int)"> +<h3>getMaxUpdateSketchBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxUpdateSketchBytes</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a>, <code>nomEntries</code></dd> +<dt>Returns:</dt> +<dd>Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSerializationVersion(org.apache.datasketches.memory.Memory)"> +<h3>getSerializationVersion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getSerializationVersion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd>Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int,org.apache.datasketches.memory.Memory)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int numStdDev, + org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Gets the approximate upper error bound from a valid memory image of a Sketch + given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>the upper bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyCompactSketch(org.apache.datasketches.memory.Memory)"> +<h3>heapifyCompactSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">heapifyCompactSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyCompactSketch(org.apache.datasketches.memory.Memory,long)"> +<h3>heapifyCompactSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">heapifyCompactSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a>, <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a>, + <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapCompactSketch(org.apache.datasketches.memory.Memory)"> +<h3>wrapCompactSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">wrapCompactSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapCompactSketch(org.apache.datasketches.memory.Memory,long)"> +<h3>wrapCompactSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">wrapCompactSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a>, <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a>, + <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifySetOperation(org.apache.datasketches.memory.Memory)"> +<h3>heapifySetOperation</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">heapifySetOperation</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifySetOperation(org.apache.datasketches.memory.Memory,long)"> +<h3>heapifySetOperation</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">heapifySetOperation</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a>, + <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a>, + <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifySketch(org.apache.datasketches.memory.Memory)"> +<h3>heapifySketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">heapifySketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifySketch(org.apache.datasketches.memory.Memory,long)"> +<h3>heapifySketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">heapifySketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a>, <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a>, <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyUpdateSketch(org.apache.datasketches.memory.Memory)"> +<h3>heapifyUpdateSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">heapifyUpdateSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyUpdateSketch(org.apache.datasketches.memory.Memory,long)"> +<h3>heapifyUpdateSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">heapifyUpdateSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a>, + <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a>, + <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setOperationBuilder()"> +<h3>setOperationBuilder</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span> <span class="element-name">setOperationBuilder</span>()</div> +<div class="block">Ref: <a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="updateSketchBuilder()"> +<h3>updateSketchBuilder</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">updateSketchBuilder</span>()</div> +<div class="block">Ref: <a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapIntersection(org.apache.datasketches.memory.Memory)"> +<h3>wrapIntersection</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></span> <span class="element-name">wrapIntersection</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd>a Intersection backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapIntersection(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrapIntersection</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></span> <span class="element-name">wrapIntersection</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd>a Intersection backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSetOperation(org.apache.datasketches.memory.Memory)"> +<h3>wrapSetOperation</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrapSetOperation</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSetOperation(org.apache.datasketches.memory.Memory,long)"> +<h3>wrapSetOperation</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrapSetOperation</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>, + <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>, + <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSetOperation(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrapSetOperation</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrapSetOperation</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSetOperation(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrapSetOperation</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span> <span class="element-name">wrapSetOperation</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>, + <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>, + <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSketch(org.apache.datasketches.memory.Memory)"> +<h3>wrapSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">wrapSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSketch(org.apache.datasketches.memory.Memory,long)"> +<h3>wrapSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span> <span class="element-name">wrapSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a>, <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - the expectedSeed used to validate the given Memory image. + Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a>, <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUnion(org.apache.datasketches.memory.Memory)"> +<h3>wrapUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></span> <span class="element-name">wrapUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd>a Union backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUnion(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrapUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></span> <span class="element-name">wrapUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd>a Union backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrapUpdateSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">wrapUpdateSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a>, <code>srcMem</code></dd> +<dt>Returns:</dt> +<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrapUpdateSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">wrapUpdateSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</span></div> +<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a>, <code>srcMem</code></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a>, <code>expectedSeed</code></dd> +<dt>Returns:</dt> +<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/Union.html b/docs/7.0.X/org/apache/datasketches/theta/Union.html new file mode 100644 index 000000000..b5d770241 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/Union.html @@ -0,0 +1,553 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Union (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: Union"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Union.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class Union" class="title">Class Union</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">org.apache.datasketches.theta.SetOperation</a> +<div class="inheritance">org.apache.datasketches.theta.Union</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Union</span> +<span class="extends-implements">extends <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span></div> +<div class="block">Compute the union of two or more theta sketches. + A new instance represents an empty set.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Union</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCurrentBytes()" class="member-name-link">getCurrentBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the number of storage bytes required for this union in its current state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Family of this SetOperation</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxUnionBytes()" class="member-name-link">getMaxUnionBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the maximum required storage bytes for this union.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of this operation as a CompactSketch of the chosen form.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Resets this Union.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a byte array image of this Union object</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#union(org.apache.datasketches.memory.Memory)" class="member-name-link">union</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Perform a Union operation with <i>this</i> union and the given Memory image of any sketch of the + Theta Family.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#union(org.apache.datasketches.theta.Sketch)" class="member-name-link">union</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Perform a Union operation with <i>this</i> union and the given on-heap sketch of the Theta Family.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">union</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">union</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the given byte array item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(char%5B%5D)" class="member-name-link">update</a><wbr>(char[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the given char array item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the given double (or float) data item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(int%5B%5D)" class="member-name-link">update</a><wbr>(int[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the given integer array item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the given long data item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(long%5B%5D)" class="member-name-link">update</a><wbr>(long[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the given long array item.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(java.lang.String)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the with the given String data item.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(java.nio.ByteBuffer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Update <i>this</i> union with the given ByteBuffer item.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.theta.SetOperation">Methods inherited from class org.apache.datasketches.theta.<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></h3> +<code><a href="SetOperation.html#builder()">builder</a>, <a href="SetOperation.html#getMaxAnotBResultBytes(int)">getMaxAnotBResultBytes</a>, <a href="SetOperation.html#getMaxIntersectionBytes(int)">getMaxIntersectionBytes</a>, <a href="SetOperation.html#getMaxUnionBytes(int)">getMaxUnionBytes</a>, <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)">heapify</a>, <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)">heapify</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory)">wrap</a>, <a href="SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory,long)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.MemoryStatus">Methods inherited from interface org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></h3> +<code><a href="../common/MemoryStatus.html#hasMemory()">hasMemory</a>, <a href="../common/MemoryStatus.html#isDirect()">isDirect</a>, <a href="../common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>Union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Union</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCurrentBytes()"> +<h3>getCurrentBytes</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getCurrentBytes</span>()</div> +<div class="block">Returns the number of storage bytes required for this union in its current state.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of storage bytes required for this union in its current state.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SetOperation.html#getFamily()">SetOperation</a></code></span></div> +<div class="block">Gets the Family of this SetOperation</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="SetOperation.html#getFamily()">getFamily</a></code> in class <code><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></dd> +<dt>Returns:</dt> +<dd>the Family of this SetOperation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxUnionBytes()"> +<h3>getMaxUnionBytes</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getMaxUnionBytes</span>()</div> +<div class="block">Returns the maximum required storage bytes for this union.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum required storage bytes for this union.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap. + This does not disturb the underlying data structure of the union. + Therefore, it is OK to continue updating the union after this operation.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the result of this operation as an ordered CompactSketch on the Java heap</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Gets the result of this operation as a CompactSketch of the chosen form. + This does not disturb the underlying data structure of the union. + Therefore, it is OK to continue updating the union after this operation.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstOrdered</code> - <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a></dd> +<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dt>Returns:</dt> +<dd>the result of this operation as a CompactSketch of the chosen form</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this Union. The seed remains intact, everything else reverts back to its virgin state.</div> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">Returns a byte array image of this Union object</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array image of this Union object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">This implements a stateless, pair-wise union operation. The returned sketch will be cut back to + the smaller of the two k values if required. + + <p>Nulls and empty sketches are ignored.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - The first argument</dd> +<dd><code>sketchB</code> - The second argument</dd> +<dt>Returns:</dt> +<dd>the result ordered CompactSketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">This implements a stateless, pair-wise union operation. The returned sketch will be cut back to + k if required, similar to the regular Union operation. + + <p>Nulls and empty sketches are ignored.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - The first argument</dd> +<dd><code>sketchB</code> - The second argument</dd> +<dd><code>dstOrdered</code> - If true, the returned CompactSketch will be ordered.</dd> +<dd><code>dstMem</code> - If not null, the returned CompactSketch will be placed in this WritableMemory.</dd> +<dt>Returns:</dt> +<dd>the result CompactSketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.theta.Sketch)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</span></div> +<div class="block">Perform a Union operation with <i>this</i> union and the given on-heap sketch of the Theta Family. + This method is not valid for the older SetSketch, which was prior to Open Source (August, 2015). + + <p>This method can be repeatedly called. + + <p>Nulls and empty sketches are ignored.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - The incoming sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.memory.Memory)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Perform a Union operation with <i>this</i> union and the given Memory image of any sketch of the + Theta Family. The input image may be from earlier versions of the Theta Compact Sketch, + called the SetSketch (circa 2014), which was prior to Open Source and are compact and ordered. + + <p>This method can be repeatedly called. + + <p>Nulls and empty sketches are ignored.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory image of sketch to be merged</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long datum)</span></div> +<div class="block">Update <i>this</i> union with the given long data item.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given long datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double datum)</span></div> +<div class="block">Update <i>this</i> union with the given double (or float) data item. + The double will be converted to a long using Double.doubleToLongBits(datum), + which normalizes all NaN values to a single NaN representation. + Plus and minus zero will be normalized to plus zero. + Each of the special floating-point values NaN and +/- Infinity are treated as distinct.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given double datum.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</span></div> +<div class="block">Update <i>this</i> union with the with the given String data item. + The string is converted to a byte array using UTF8 encoding. + If the string is null or empty no update attempt is made and the method returns. + + <p>Note: this will not produce the same output hash values as the <a href="#update(char%5B%5D)"><code>update(char[])</code></a> + method and will generally be a little slower depending on the complexity of the UTF8 encoding. + </p> + + <p>Note: this is not a Sketch Union operation. This treats the given string as a data item.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given String.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Update <i>this</i> union with the given byte array item. + If the byte array is null or empty no update attempt is made and the method returns. + + <p>Note: this is not a Sketch Union operation. This treats the given byte array as a data + item.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given byte array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.nio.ByteBuffer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> data)</span></div> +<div class="block">Update <i>this</i> union with the given ByteBuffer item. + If the ByteBuffer is null or empty no update attempt is made and the method returns. + + <p>Note: this is not a Sketch Union operation. This treats the given ByteBuffer as a data + item.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given ByteBuffer.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Update <i>this</i> union with the given integer array item. + If the integer array is null or empty no update attempt is made and the method returns. + + <p>Note: this is not a Sketch Union operation. This treats the given integer array as a data + item.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given int array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(char[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Update <i>this</i> union with the given char array item. + If the char array is null or empty no update attempt is made and the method returns. + + <p>Note: this will not produce the same output hash values as the <a href="#update(java.lang.String)"><code>update(String)</code></a> + method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p> + + <p>Note: this is not a Sketch Union operation. This treats the given char array as a data + item.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given char array.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Update <i>this</i> union with the given long array item. + If the long array is null or empty no update attempt is made and the method returns. + + <p>Note: this is not a Sketch Union operation. This treats the given char array as a data + item.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given long array.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/UpdateReturnState.html b/docs/7.0.X/org/apache/datasketches/theta/UpdateReturnState.html new file mode 100644 index 000000000..5f10580d6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/UpdateReturnState.html @@ -0,0 +1,317 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UpdateReturnState (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, enum: UpdateReturnState"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UpdateReturnState.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Enum Class UpdateReturnState" class="title">Enum Class UpdateReturnState</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a>> +<div class="inheritance">org.apache.datasketches.theta.UpdateReturnState</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">UpdateReturnState</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a>></span></div> +<div class="block"><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#ConcurrentBufferInserted" class="member-name-link">ConcurrentBufferInserted</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The hash was inserted into the local concurrent buffer, + but has not yet been propagated to the concurrent shared sketch.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#ConcurrentPropagated" class="member-name-link">ConcurrentPropagated</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The hash has been propagated to the concurrent shared sketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="#InsertedCountIncremented" class="member-name-link">InsertedCountIncremented</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The hash was accepted into the sketch and the retained count was incremented.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#InsertedCountIncrementedRebuilt" class="member-name-link">InsertedCountIncrementedRebuilt</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The hash was accepted into the sketch, the retained count was incremented.</div> +</div> +<div class="col-first even-row-color"><code><a href="#InsertedCountIncrementedResized" class="member-name-link">InsertedCountIncrementedResized</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The hash was accepted into the sketch, the retained count was incremented.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#InsertedCountNotIncremented" class="member-name-link">InsertedCountNotIncremented</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The hash was accepted into the sketch and the retained count was not incremented.</div> +</div> +<div class="col-first even-row-color"><code><a href="#RejectedDuplicate" class="member-name-link">RejectedDuplicate</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The hash was rejected as a duplicate.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#RejectedNullOrEmpty" class="member-name-link">RejectedNullOrEmpty</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The hash was rejected because it was null or empty.</div> +</div> +<div class="col-first even-row-color"><code><a href="#RejectedOverTheta" class="member-name-link">RejectedOverTheta</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The hash was rejected because the value was negative, zero or + greater than theta.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="InsertedCountIncremented"> +<h3>InsertedCountIncremented</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">InsertedCountIncremented</span></div> +<div class="block">The hash was accepted into the sketch and the retained count was incremented.</div> +</section> +</li> +<li> +<section class="detail" id="InsertedCountIncrementedResized"> +<h3>InsertedCountIncrementedResized</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">InsertedCountIncrementedResized</span></div> +<div class="block">The hash was accepted into the sketch, the retained count was incremented. + The current cache was out of room and resized larger based on the Resize Factor.</div> +</section> +</li> +<li> +<section class="detail" id="InsertedCountIncrementedRebuilt"> +<h3>InsertedCountIncrementedRebuilt</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">InsertedCountIncrementedRebuilt</span></div> +<div class="block">The hash was accepted into the sketch, the retained count was incremented. + The current cache was out of room and at maximum size, so the cache was rebuilt.</div> +</section> +</li> +<li> +<section class="detail" id="InsertedCountNotIncremented"> +<h3>InsertedCountNotIncremented</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">InsertedCountNotIncremented</span></div> +<div class="block">The hash was accepted into the sketch and the retained count was not incremented.</div> +</section> +</li> +<li> +<section class="detail" id="ConcurrentBufferInserted"> +<h3>ConcurrentBufferInserted</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">ConcurrentBufferInserted</span></div> +<div class="block">The hash was inserted into the local concurrent buffer, + but has not yet been propagated to the concurrent shared sketch.</div> +</section> +</li> +<li> +<section class="detail" id="ConcurrentPropagated"> +<h3>ConcurrentPropagated</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">ConcurrentPropagated</span></div> +<div class="block">The hash has been propagated to the concurrent shared sketch. + This does not reflect the action taken by the shared sketch.</div> +</section> +</li> +<li> +<section class="detail" id="RejectedDuplicate"> +<h3>RejectedDuplicate</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">RejectedDuplicate</span></div> +<div class="block">The hash was rejected as a duplicate.</div> +</section> +</li> +<li> +<section class="detail" id="RejectedNullOrEmpty"> +<h3>RejectedNullOrEmpty</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">RejectedNullOrEmpty</span></div> +<div class="block">The hash was rejected because it was null or empty.</div> +</section> +</li> +<li> +<section class="detail" id="RejectedOverTheta"> +<h3>RejectedOverTheta</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">RejectedOverTheta</span></div> +<div class="block">The hash was rejected because the value was negative, zero or + greater than theta.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/UpdateSketch.html b/docs/7.0.X/org/apache/datasketches/theta/UpdateSketch.html new file mode 100644 index 000000000..a62c36ed3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/UpdateSketch.html @@ -0,0 +1,588 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UpdateSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: UpdateSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UpdateSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class UpdateSketch" class="title">Class UpdateSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="Sketch.html" title="class in org.apache.datasketches.theta">org.apache.datasketches.theta.Sketch</a> +<div class="inheritance">org.apache.datasketches.theta.UpdateSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">UpdateSketch</span> +<span class="extends-implements">extends <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span></div> +<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha. + The primary task of an Update Sketch is to consider datums presented via the update() methods + for inclusion in its internal cache. This is the sketch building process.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns a new builder</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Convert this sketch to a <i>CompactSketch</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompactBytes()" class="member-name-link">getCompactBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the number of storage bytes required for this Sketch if its current state were + compacted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLgNomLongs()" class="member-name-link">getLgNomLongs</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the Log base 2 of the configured nominal entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns the configured ResizeFactor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCompact()" class="member-name-link">isCompact</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if this sketch is in compact form.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isOrdered()" class="member-name-link">isOrdered</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if internal cache is ordered</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rebuild()" class="member-name-link">rebuild</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Rebuilds the hash table to remove dirty values or to reduce the size + to nominal entries.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Resets this sketch back to a virgin empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] data)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with the given byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(char%5B%5D)" class="member-name-link">update</a><wbr>(char[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with the given char array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double)" class="member-name-link">update</a><wbr>(double datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with the given double (or float) datum.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(int%5B%5D)" class="member-name-link">update</a><wbr>(int[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with the given integer array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long)" class="member-name-link">update</a><wbr>(long datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with a long.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D)" class="member-name-link">update</a><wbr>(long[] data)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with the given long array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with the given String.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.nio.ByteBuffer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Present this sketch with the given ByteBuffer + If the ByteBuffer is null or empty, no update attempt is made and the method returns.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.theta.Sketch">Methods inherited from class org.apache.datasketches.theta.<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></h3> +<code><a href="Sketch.html#compact()">compact</a>, <a href="Sketch.html#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes</a>, <a href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a>, <a href="Sketch.html#getCurrentBytes()">getCurrentBytes</a>, <a href="Sketch.html#getEstimate()">getEstimate</a>, <a href="Sketch.html#getFamily()">getFamily</a>, <a href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="Sketch.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes</a>, <a href="Sketch.html#getMaxUpdateSketchBytes(int)">getMaxUpdateSketchBytes</a>, <a href="Sketch.html#getRetainedEntries()">getRetainedEntries</a>, <a href="Sketch.html#getRetainedEntries(boolean)">getRetainedEntries</a>, <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)">getSerializationVersion</a>, <a href="Sketch.html#getTheta()">getTheta</a>, <a href="Sketch.html#getThetaLong()">getThetaLong</a>, <a href="Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="Sketch.html#isEmpty()">isEmpty</a>, <a href="Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="Sketch.html#iterator()">iterator</a>, <a href="Sketch.html#toByteArray()">toByteArray</a>, <a href="Sketch.html#toString()">toString</a>, <a href="Sketch.html#toString(boolean,boolean,int,boolean)">toString</a>, <a href="Sketch.html#toString(byte%5B%5D)">toString</a>, <a href="Sketch.html#toString(org.apache.datasketches.memory.Memory)">toString</a>, <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a>, <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.common.MemoryStatus">Methods inherited from interface org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a></h3> +<code><a href="../common/MemoryStatus.html#hasMemory()">hasMemory</a>, <a href="../common/MemoryStatus.html#isDirect()">isDirect</a>, <a href="../common/MemoryStatus.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly. There is no data copying onto + the java heap. Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have + been explicitly stored as direct objects can be wrapped. This method assumes the + <a href="../thetacommon/ThetaUtil.html#DEFAULT_UPDATE_SEED"><code>ThetaUtil.DEFAULT_UPDATE_SEED</code></a>. + <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch where the image seed hash matches the default seed hash. + It must have a size of at least 24 bytes. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dt>Returns:</dt> +<dd>a Sketch backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</span></div> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly. There is no data copying onto + the java heap. Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have + been explicitly stored as direct objects can be wrapped. + An attempt to "wrap" earlier version sketches will result in a "heapified", normal + Java Heap version of the sketch where all data will be copied to the heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - an image of a Sketch where the image seed hash matches the given seed hash. + It must have a size of at least 24 bytes. + <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>. + Compact sketches store a 16-bit hash of the seed, but not the seed itself.</dd> +<dt>Returns:</dt> +<dd>a UpdateSketch backed by the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Instantiates an on-heap UpdateSketch from Memory. This method assumes the + <a href="../thetacommon/ThetaUtil.html#DEFAULT_UPDATE_SEED"><code>ThetaUtil.DEFAULT_UPDATE_SEED</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a> + It must have a size of at least 24 bytes.</dd> +<dt>Returns:</dt> +<dd>an UpdateSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</span></div> +<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a> + It must have a size of at least 24 bytes.</dd> +<dd><code>expectedSeed</code> - the seed used to validate the given Memory image. + <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd> +<dt>Returns:</dt> +<dd>an UpdateSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact(boolean,org.apache.datasketches.memory.WritableMemory)"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span> <span class="element-name">compact</span><wbr><span class="parameters">(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)">Sketch</a></code></span></div> +<div class="block">Convert this sketch to a <i>CompactSketch</i>. + + <p>If this sketch is a type of <i>UpdateSketch</i>, the compacting process converts the hash table + of the <i>UpdateSketch</i> to a simple list of the valid hash values. + Any hash values of zero or equal-to or greater than theta will be discarded. + The number of valid values remaining in the <i>CompactSketch</i> depends on a number of factors, + but may be larger or smaller than <i>Nominal Entries</i> (or <i>k</i>). + It will never exceed 2<i>k</i>. + If it is critical to always limit the size to no more than <i>k</i>, + then <i>rebuild()</i> should be called on the <i>UpdateSketch</i> prior to calling this method.</p> + + <p>A <i>CompactSketch</i> is always immutable.</p> + + <p>A new <i>CompactSketch</i> object is created:</p> + <ul><li>if <i>dstMem != null</i></li> + <li>if <i>dstMem == null</i> and <i>this.hasMemory() == true</i></li> + <li>if <i>dstMem == null</i> and <i>this</i> has more than 1 item and <i>this.isOrdered() == false</i> + and <i>dstOrdered == true</i>.</li> +</ul> + + <p>Otherwise, this operation returns <i>this</i>.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)">compact</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>dstOrdered</code> - assumed true if this sketch is empty or has only one value + <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a></dd> +<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> +<dt>Returns:</dt> +<dd>this sketch as a <i>CompactSketch</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCompactBytes()"> +<h3>getCompactBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCompactBytes</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#getCompactBytes()">Sketch</a></code></span></div> +<div class="block">Returns the number of storage bytes required for this Sketch if its current state were + compacted. It this sketch is already in the compact form this is equivalent to + calling <a href="Sketch.html#getCurrentBytes()"><code>Sketch.getCurrentBytes()</code></a>.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#getCompactBytes()">getCompactBytes</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Returns:</dt> +<dd>number of compact bytes</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isCompact()"> +<h3>isCompact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCompact</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#isCompact()">Sketch</a></code></span></div> +<div class="block">Returns true if this sketch is in compact form.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#isCompact()">isCompact</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Returns:</dt> +<dd>true if this sketch is in compact form.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isOrdered()"> +<h3>isOrdered</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOrdered</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#isOrdered()">Sketch</a></code></span></div> +<div class="block">Returns true if internal cache is ordered</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#isOrdered()">isOrdered</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd> +<dt>Returns:</dt> +<dd>true if internal cache is ordered</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="builder()"> +<h3>builder</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">builder</span>()</div> +<div class="block">Returns a new builder</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a new builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Returns the configured ResizeFactor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the configured ResizeFactor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch back to a virgin empty state.</div> +</section> +</li> +<li> +<section class="detail" id="rebuild()"> +<h3>rebuild</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">rebuild</span>()</div> +<div class="block">Rebuilds the hash table to remove dirty values or to reduce the size + to nominal entries.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(long datum)</span></div> +<div class="block">Present this sketch with a long.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given long datum.</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(double datum)</span></div> +<div class="block">Present this sketch with the given double (or float) datum. + The double will be converted to a long using Double.doubleToLongBits(datum), + which normalizes all NaN values to a single NaN representation. + Plus and minus zero will be normalized to plus zero. + The special floating-point values NaN and +/- Infinity are treated as distinct.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given double datum.</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</span></div> +<div class="block">Present this sketch with the given String. + The string is converted to a byte array using UTF8 encoding. + If the string is null or empty no update attempt is made and the method returns. + + <p>Note: this will not produce the same output hash values as the <a href="#update(char%5B%5D)"><code>update(char[])</code></a> + method and will generally be a little slower depending on the complexity of the UTF8 encoding. + </p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>datum</code> - The given String.</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] data)</span></div> +<div class="block">Present this sketch with the given byte array. + If the byte array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given byte array.</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.nio.ByteBuffer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</span></div> +<div class="block">Present this sketch with the given ByteBuffer + If the ByteBuffer is null or empty, no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>buffer</code> - the input ByteBuffer</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(char[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(char[] data)</span></div> +<div class="block">Present this sketch with the given char array. + If the char array is null or empty no update attempt is made and the method returns. + + <p>Note: this will not produce the same output hash values as the <a href="#update(java.lang.String)"><code>update(String)</code></a> + method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given char array.</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(int[] data)</span></div> +<div class="block">Present this sketch with the given integer array. + If the integer array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given int array.</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span> <span class="element-name">update</span><wbr><span class="parameters">(long[] data)</span></div> +<div class="block">Present this sketch with the given long array. + If the long array is null or empty no update attempt is made and the method returns.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>data</code> - The given long array.</dd> +<dt>Returns:</dt> +<dd><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgNomLongs()"> +<h3>getLgNomLongs</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getLgNomLongs</span>()</div> +<div class="block">Gets the Log base 2 of the configured nominal entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Log base 2 of the configured nominal entries</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/UpdateSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/theta/UpdateSketchBuilder.html new file mode 100644 index 000000000..a116042a3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/UpdateSketchBuilder.html @@ -0,0 +1,784 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UpdateSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta, class: UpdateSketchBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UpdateSketchBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.theta</a></div> +<h1 title="Class UpdateSketchBuilder" class="title">Class UpdateSketchBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.theta.UpdateSketchBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">UpdateSketchBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">For building a new UpdateSketch.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">UpdateSketchBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructor for building a new UpdateSketch.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder + with the specified backing destination Memory store.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildLocal(org.apache.datasketches.theta.UpdateSketch)" class="member-name-link">buildLocal</a><wbr>(<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> shared)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a local, on-heap, concurrent UpdateSketch to be used as a per-thread local buffer + along with the given concurrent shared UpdateSketch and the current configuration of this + Builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildShared()" class="member-name-link">buildShared</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an on-heap concurrent shared UpdateSketch with the current configuration of the + Builder.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildShared(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildShared</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder and the given destination WritableMemory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildSharedFromSketch(org.apache.datasketches.theta.UpdateSketch,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildSharedFromSketch</a><wbr>(<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> sketch, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder, the data from the given sketch, and the given destination + WritableMemory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Family</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgNominalEntries()" class="member-name-link">getLgNominalEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns Log-base 2 Nominal Entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocalLgNominalEntries()" class="member-name-link">getLocalLgNominalEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns Log-base 2 Nominal Entries for the concurrent local sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxConcurrencyError()" class="member-name-link">getMaxConcurrencyError</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Maximum Concurrency Error</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxNumLocalThreads()" class="member-name-link">getMaxNumLocalThreads</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Maximum Number of Local Threads.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.datasketches.memory.MemoryRequestServer</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMemoryRequestServer()" class="member-name-link">getMemoryRequestServer</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the MemoryRequestServer</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumPoolThreads()" class="member-name-link">getNumPoolThreads</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of background pool threads used for propagation in the concurrent sketches.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getP()" class="member-name-link">getP</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the pre-sampling probability <i>p</i></div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPropagateOrderedCompact()" class="member-name-link">getPropagateOrderedCompact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Propagate Ordered Compact flag used with concurrent sketches.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the Resize Factor</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSeed()" class="member-name-link">getSeed</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the seed</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFamily(org.apache.datasketches.common.Family)" class="member-name-link">setFamily</a><wbr>(<a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Set the Family.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLocalLogNominalEntries(int)" class="member-name-link">setLocalLogNominalEntries</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Alternative method of setting the Nominal Entries for a local concurrent sketch from the + log_base2 value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLocalNominalEntries(int)" class="member-name-link">setLocalNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the Nominal Entries for the concurrent local sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLogNominalEntries(int)" class="member-name-link">setLogNominalEntries</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Alternative method of setting the Nominal Entries for this sketch from the log_base2 value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxConcurrencyError(double)" class="member-name-link">setMaxConcurrencyError</a><wbr>(double maxConcurrencyError)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the Maximum Concurrency Error.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxNumLocalThreads(int)" class="member-name-link">setMaxNumLocalThreads</a><wbr>(int maxNumLocalThreads)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the Maximum Number of Local Threads.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">setMemoryRequestServer</a><wbr>(org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Set the MemoryRequestServer</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the Nominal Entries for this sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumPoolThreads(int)" class="member-name-link">setNumPoolThreads</a><wbr>(int numPoolThreads)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the number of pool threads used for background propagation in the concurrent sketches.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setP(float)" class="member-name-link">setP</a><wbr>(float p)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPropagateOrderedCompact(boolean)" class="member-name-link">setPropagateOrderedCompact</a><wbr>(boolean prop)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the Propagate Ordered Compact flag to the given value.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the cache Resize Factor.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>UpdateSketchBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">UpdateSketchBuilder</span>()</div> +<div class="block">Constructor for building a new UpdateSketch. The default configuration is + <ul> + <li>Nominal Entries: <a href="../thetacommon/ThetaUtil.html#DEFAULT_NOMINAL_ENTRIES">4096</a></li> + <li>Seed: <a href="../thetacommon/ThetaUtil.html#DEFAULT_UPDATE_SEED">9001L</a></li> + <li>Input Sampling Probability: 1.0</li> + <li>Family: <a href="../common/Family.html#QUICKSELECT"><code>Family.QUICKSELECT</code></a></li> + <li>Resize Factor: The default for sketches on the Java heap is <a href="../common/ResizeFactor.html#X8"><code>ResizeFactor.X8</code></a>. + For direct sketches, which are targeted for native memory off the Java heap, this value will + be fixed at either <a href="../common/ResizeFactor.html#X1"><code>ResizeFactor.X1</code></a> or <a href="../common/ResizeFactor.html#X2"><code>ResizeFactor.X2</code></a>.</li> + <li>MemoryRequestServer (Direct only): + <code>DefaultMemoryRequestServer</code>.</li> + </ul> + Parameters unique to the concurrent sketches only: + <ul> + <li>Number of local Nominal Entries: 4</li> + <li>Concurrent NumPoolThreads: 3</li> + <li>Concurrent PropagateOrderedCompact: true</li> + <li>Concurrent MaxConcurrencyError: 0</li> + </ul></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setNominalEntries(int)"> +<h3>setNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setNominalEntries</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Sets the Nominal Entries for this sketch. + This value is also used for building a shared concurrent sketch. + The minimum value is 16 (2^4) and the maximum value is 67,108,864 (2^26). + Be aware that sketches as large as this maximum value may not have been + thoroughly tested or characterized for performance.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a> + This will become the ceiling power of 2 if the given value is not.</dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setLogNominalEntries(int)"> +<h3>setLogNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setLogNominalEntries</span><wbr><span class="parameters">(int lgNomEntries)</span></div> +<div class="block">Alternative method of setting the Nominal Entries for this sketch from the log_base2 value. + This value is also used for building a shared concurrent sketch. + The minimum value is 4 and the maximum value is 26. + Be aware that sketches as large as this maximum value may not have been + thoroughly characterized for performance.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgNomEntries</code> - the Log Nominal Entries. Also for the concurrent shared sketch</dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgNominalEntries()"> +<h3>getLgNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgNominalEntries</span>()</div> +<div class="block">Returns Log-base 2 Nominal Entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Log-base 2 Nominal Entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setLocalNominalEntries(int)"> +<h3>setLocalNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setLocalNominalEntries</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">Sets the Nominal Entries for the concurrent local sketch. The minimum value is 16 and the + maximum value is 67,108,864, which is 2^26. + Be aware that sketches as large as this maximum + value have not been thoroughly tested or characterized for performance.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a> + This will become the ceiling power of 2 if it is not.</dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setLocalLogNominalEntries(int)"> +<h3>setLocalLogNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setLocalLogNominalEntries</span><wbr><span class="parameters">(int lgNomEntries)</span></div> +<div class="block">Alternative method of setting the Nominal Entries for a local concurrent sketch from the + log_base2 value. + The minimum value is 4 and the maximum value is 26. + Be aware that sketches as large as this maximum + value have not been thoroughly tested or characterized for performance.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgNomEntries</code> - the Log Nominal Entries for a concurrent local sketch</dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLocalLgNominalEntries()"> +<h3>getLocalLgNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLocalLgNominalEntries</span>()</div> +<div class="block">Returns Log-base 2 Nominal Entries for the concurrent local sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Log-base 2 Nominal Entries for the concurrent local sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setSeed(long)"> +<h3>setSeed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setSeed</span><wbr><span class="parameters">(long seed)</span></div> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seed</code> - <a href="../../../../resources/dictionary.html#seed">See seed</a></dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSeed()"> +<h3>getSeed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getSeed</span>()</div> +<div class="block">Returns the seed</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the seed</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setP(float)"> +<h3>setP</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setP</span><wbr><span class="parameters">(float p)</span></div> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>p</code> - <a href="../../../../resources/dictionary.html#p">See Sampling Probability, <i>p</i></a></dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getP()"> +<h3>getP</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getP</span>()</div> +<div class="block">Returns the pre-sampling probability <i>p</i></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the pre-sampling probability <i>p</i></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setResizeFactor(org.apache.datasketches.common.ResizeFactor)"> +<h3>setResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setResizeFactor</span><wbr><span class="parameters">(<a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</span></div> +<div class="block">Sets the cache Resize Factor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>rf</code> - <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Returns the Resize Factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Resize Factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setFamily(org.apache.datasketches.common.Family)"> +<h3>setFamily</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setFamily</span><wbr><span class="parameters">(<a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</span></div> +<div class="block">Set the Family.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>family</code> - the family for this builder</dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getFamily()"> +<h3>getFamily</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">getFamily</span>()</div> +<div class="block">Returns the Family</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Family</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)"> +<h3>setMemoryRequestServer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setMemoryRequestServer</span><wbr><span class="parameters">(org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</span></div> +<div class="block">Set the MemoryRequestServer</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>memReqSvr</code> - the given MemoryRequestServer</dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMemoryRequestServer()"> +<h3>getMemoryRequestServer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.datasketches.memory.MemoryRequestServer</span> <span class="element-name">getMemoryRequestServer</span>()</div> +<div class="block">Returns the MemoryRequestServer</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the MemoryRequestServer</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setNumPoolThreads(int)"> +<h3>setNumPoolThreads</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setNumPoolThreads</span><wbr><span class="parameters">(int numPoolThreads)</span></div> +<div class="block">Sets the number of pool threads used for background propagation in the concurrent sketches.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numPoolThreads</code> - the given number of pool threads</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumPoolThreads()"> +<h3>getNumPoolThreads</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumPoolThreads</span>()</div> +<div class="block">Gets the number of background pool threads used for propagation in the concurrent sketches.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the number of background pool threads</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setPropagateOrderedCompact(boolean)"> +<h3>setPropagateOrderedCompact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span> <span class="element-name">setPropagateOrderedCompact</span><wbr><span class="parameters">(boolean prop)</span></div> +<div class="block">Sets the Propagate Ordered Compact flag to the given value. Used with concurrent sketches.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>prop</code> - the given value</dd> +<dt>Returns:</dt> +<dd>this UpdateSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPropagateOrderedCompact()"> +<h3>getPropagateOrderedCompact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getPropagateOrderedCompact</span>()</div> +<div class="block">Gets the Propagate Ordered Compact flag used with concurrent sketches.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Propagate Ordered Compact flag</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setMaxConcurrencyError(double)"> +<h3>setMaxConcurrencyError</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxConcurrencyError</span><wbr><span class="parameters">(double maxConcurrencyError)</span></div> +<div class="block">Sets the Maximum Concurrency Error.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxConcurrencyError</code> - the given Maximum Concurrency Error.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxConcurrencyError()"> +<h3>getMaxConcurrencyError</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getMaxConcurrencyError</span>()</div> +<div class="block">Gets the Maximum Concurrency Error</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Maximum Concurrency Error</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setMaxNumLocalThreads(int)"> +<h3>setMaxNumLocalThreads</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxNumLocalThreads</span><wbr><span class="parameters">(int maxNumLocalThreads)</span></div> +<div class="block">Sets the Maximum Number of Local Threads. + This is used to set the size of the local concurrent buffers.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>maxNumLocalThreads</code> - the given Maximum Number of Local Threads</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxNumLocalThreads()"> +<h3>getMaxNumLocalThreads</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxNumLocalThreads</span>()</div> +<div class="block">Gets the Maximum Number of Local Threads.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Maximum Number of Local Threads.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build()"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">build</span>()</div> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an UpdateSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build(org.apache.datasketches.memory.WritableMemory)"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">build</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder + with the specified backing destination Memory store. + Note: this cannot be used with the Alpha Family of sketches.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - The destination Memory.</dd> +<dt>Returns:</dt> +<dd>an UpdateSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildShared()"> +<h3>buildShared</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">buildShared</span>()</div> +<div class="block">Returns an on-heap concurrent shared UpdateSketch with the current configuration of the + Builder. + + <p>The parameters unique to the shared concurrent sketch are: + <ul> + <li>Number of Pool Threads (default is 3)</li> + <li>Maximum Concurrency Error</li> + </ul> + + <p>Key parameters that are in common with other <i>Theta</i> sketches: + <ul> + <li>Nominal Entries or Log Nominal Entries (for the shared concurrent sketch)</li> + </ul></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an on-heap concurrent UpdateSketch with the current configuration of the Builder.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildShared(org.apache.datasketches.memory.WritableMemory)"> +<h3>buildShared</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">buildShared</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder and the given destination WritableMemory. If the destination + WritableMemory is null, this defaults to an on-heap concurrent shared UpdateSketch. + + <p>The parameters unique to the shared concurrent sketch are: + <ul> + <li>Number of Pool Threads (default is 3)</li> + <li>Maximum Concurrency Error</li> + </ul> + + <p>Key parameters that are in common with other <i>Theta</i> sketches: + <ul> + <li>Nominal Entries or Log Nominal Entries (for the shared concurrent sketch)</li> + <li>Destination Writable Memory (if not null, returned sketch is Direct. Default is null.)</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the given WritableMemory for Direct, otherwise <i>null</i>.</dd> +<dt>Returns:</dt> +<dd>a concurrent UpdateSketch with the current configuration of the Builder + and the given destination WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildSharedFromSketch(org.apache.datasketches.theta.UpdateSketch,org.apache.datasketches.memory.WritableMemory)"> +<h3>buildSharedFromSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">buildSharedFromSketch</span><wbr><span class="parameters">(<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> sketch, + org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder, the data from the given sketch, and the given destination + WritableMemory. If the destination WritableMemory is null, this defaults to an on-heap + concurrent shared UpdateSketch. + + <p>The parameters unique to the shared concurrent sketch are: + <ul> + <li>Number of Pool Threads (default is 3)</li> + <li>Maximum Concurrency Error</li> + </ul> + + <p>Key parameters that are in common with other <i>Theta</i> sketches: + <ul> + <li>Nominal Entries or Log Nominal Entries (for the shared concurrent sketch)</li> + <li>Destination Writable Memory (if not null, returned sketch is Direct. Default is null.)</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - a given UpdateSketch from which the data is used to initialize the returned + shared sketch.</dd> +<dd><code>dstMem</code> - the given WritableMemory for Direct, otherwise <i>null</i>.</dd> +<dt>Returns:</dt> +<dd>a concurrent UpdateSketch with the current configuration of the Builder + and the given destination WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildLocal(org.apache.datasketches.theta.UpdateSketch)"> +<h3>buildLocal</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span> <span class="element-name">buildLocal</span><wbr><span class="parameters">(<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> shared)</span></div> +<div class="block">Returns a local, on-heap, concurrent UpdateSketch to be used as a per-thread local buffer + along with the given concurrent shared UpdateSketch and the current configuration of this + Builder. + + <p>The parameters unique to the local concurrent sketch are: + <ul> + <li>Local Nominal Entries or Local Log Nominal Entries</li> + <li>Propagate Ordered Compact flag</li> + </ul></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>shared</code> - the concurrent shared sketch to be accessed via the concurrent local sketch.</dd> +<dt>Returns:</dt> +<dd>an UpdateSketch to be used as a per-thread local buffer.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/AnotB.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/AnotB.html new file mode 100644 index 000000000..fdcaf3431 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/AnotB.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.AnotB (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: AnotB"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../AnotB.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.AnotB" class="title">Uses of Class<br>org.apache.datasketches.theta.AnotB</h1> +</div> +<div class="caption"><span>Packages that use <a href="../AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#buildANotB()" class="member-name-link">buildANotB</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Convenience method, returns a configured SetOperation ANotB with + <a href="../../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/BitPacking.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/BitPacking.html new file mode 100644 index 000000000..db8c08a5e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/BitPacking.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.BitPacking (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: BitPacking"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BitPacking.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.BitPacking" class="title">Uses of Class<br>org.apache.datasketches.theta.BitPacking</h1> +</div> +No usage of org.apache.datasketches.theta.BitPacking</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/CompactSketch.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/CompactSketch.html new file mode 100644 index 000000000..bd64e7f9d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/CompactSketch.html @@ -0,0 +1,234 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.CompactSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: CompactSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.CompactSketch" class="title">Uses of Class<br>org.apache.datasketches.theta.CompactSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as an + ordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as a + CompactSketch.</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Converts this sketch to a ordered CompactSketch.</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Convert this sketch to a <i>CompactSketch</i>.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#compact(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#getResult(boolean)" class="member-name-link">getResult</a><wbr>(boolean reset)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="../AnotB.html#setA(org.apache.datasketches.theta.Sketch)"><code>AnotB.setA(Sketch)</code></a> and (<a href="../AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(Sketch)</code></a> or + <a href="../AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#getResult(boolean,org.apache.datasketches.memory.WritableMemory,boolean)" class="member-name-link">getResult</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem, + boolean reset)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="../AnotB.html#setA(org.apache.datasketches.theta.Sketch)"><code>AnotB.setA(Sketch)</code></a> and (<a href="../AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(Sketch)</code></a> or + <a href="../AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#getResult(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of this operation as a CompactSketch in the given dstMem.</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getResult(boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of this operation as a CompactSketch of the chosen form.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyCompactSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyCompactSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform intersect set operation on the two given sketch arguments and return the result as an + ordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform intersect set operation on the two given sketches and return the result as a + CompactSketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap takes the CompactSketch image in given Memory and refers to it directly.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapCompactSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapCompactSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapCompactSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a></div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/HashIterator.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/HashIterator.html new file mode 100644 index 000000000..b5ec74fc3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/HashIterator.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.theta.HashIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, interface: HashIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../HashIterator.html" title="interface in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.theta.HashIterator" class="title">Uses of Interface<br>org.apache.datasketches.theta.HashIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>abstract <a href="../HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a HashIterator that can be used to iterate over the retained hash values of the + Theta sketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/Intersection.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/Intersection.html new file mode 100644 index 000000000..aafada0d9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/Intersection.html @@ -0,0 +1,110 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.Intersection (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: Intersection"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Intersection.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.Intersection" class="title">Uses of Class<br>org.apache.datasketches.theta.Intersection</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#buildIntersection()" class="member-name-link">buildIntersection</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="../../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +</div> +<div class="col-first odd-row-color"><code><a href="../Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#buildIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildIntersection</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Convenience method, returns a configured SetOperation Intersection with + <a href="../../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapIntersection(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapIntersection</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Convenience method, calls <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapIntersection</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Convenience method, calls <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/JaccardSimilarity.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/JaccardSimilarity.html new file mode 100644 index 000000000..0f62fd7c4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/JaccardSimilarity.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.JaccardSimilarity (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: JaccardSimilarity"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../JaccardSimilarity.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.JaccardSimilarity" class="title">Uses of Class<br>org.apache.datasketches.theta.JaccardSimilarity</h1> +</div> +No usage of org.apache.datasketches.theta.JaccardSimilarity</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/SetOperation.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/SetOperation.html new file mode 100644 index 000000000..90c7f2afb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/SetOperation.html @@ -0,0 +1,189 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.SetOperation (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: SetOperation"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SetOperation.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.SetOperation" class="title">Uses of Class<br>org.apache.datasketches.theta.SetOperation</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Subclasses of <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../AnotB.html" class="type-name-link" title="class in org.apache.datasketches.theta">AnotB</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../Intersection.html" class="type-name-link" title="class in org.apache.datasketches.theta">Intersection</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The API for intersection operations</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../Union.html" class="type-name-link" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Compute the union of two or more theta sketches.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#build(org.apache.datasketches.common.Family)" class="member-name-link">build</a><wbr>(<a href="../../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(<a href="../../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family + and the given destination memory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../SetOperation.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify takes the SetOperations image in Memory and instantiates an on-heap + SetOperation using the + <a href="../../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify takes the SetOperation image in Memory and instantiates an on-heap + SetOperation using the given expectedSeed.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifySetOperation(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifySetOperation(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../SetOperation.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap takes the SetOperation image in Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapSetOperation(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapSetOperation(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapSetOperation(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapSetOperation(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapSetOperation</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/SetOperationBuilder.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/SetOperationBuilder.html new file mode 100644 index 000000000..9bf8aacf6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/SetOperationBuilder.html @@ -0,0 +1,127 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.SetOperationBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: SetOperationBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.SetOperationBuilder" class="title">Uses of Class<br>org.apache.datasketches.theta.SetOperationBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperation.</span><code><a href="../SetOperation.html#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Makes a new builder</div> +</div> +<div class="col-first odd-row-color"><code><a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#setLogNominalEntries(int)" class="member-name-link">setLogNominalEntries</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Alternative method of setting the Nominal Entries for this set operation from the log_base2 value.</div> +</div> +<div class="col-first even-row-color"><code><a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">setMemoryRequestServer</a><wbr>(org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Set the MemoryRequestServer</div> +</div> +<div class="col-first odd-row-color"><code><a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the Maximum Nominal Entries (max K) for this set operation.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#setOperationBuilder()" class="member-name-link">setOperationBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></div> +</div> +<div class="col-first odd-row-color"><code><a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#setP(float)" class="member-name-link">setP</a><wbr>(float p)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i>.</div> +</div> +<div class="col-first even-row-color"><code><a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last even-row-color"> +<div class="block">Sets the cache Resize Factor</div> +</div> +<div class="col-first odd-row-color"><code><a href="../SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the long seed value that is require by the hashing function.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/Sketch.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/Sketch.html new file mode 100644 index 000000000..c49425654 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/Sketch.html @@ -0,0 +1,394 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.Sketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: Sketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Sketch.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.Sketch" class="title">Uses of Class<br>org.apache.datasketches.theta.Sketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Subclasses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The parent class of all the CompactSketches.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../UpdateSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a></div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as an + ordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as a + CompactSketch.</div> +</div> +<div class="col-first even-row-color"><code>static boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first even-row-color"><code>abstract void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</code></div> +<div class="col-last even-row-color"> +<div class="block">Intersect the given sketch with the internal state.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform intersect set operation on the two given sketch arguments and return the result as an + ordered CompactSketch on the heap.</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform intersect set operation on the two given sketches and return the result as a + CompactSketch.</div> +</div> +<div class="col-first odd-row-color"><code>static double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">jaccard</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first even-row-color"><code>abstract void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#notB(org.apache.datasketches.theta.Sketch)" class="member-name-link">notB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first odd-row-color"><code>abstract void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#setA(org.apache.datasketches.theta.Sketch)" class="member-name-link">setA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first even-row-color"><code>static boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>abstract void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.theta.Sketch)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform a Union operation with <i>this</i> union and the given on-heap sketch of the Theta Family.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + boolean dstOrdered, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This implements a stateless, pair-wise union operation.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></h2> +<div class="caption"><span>Methods in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInThetaSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first even-row-color"><code>static double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInThetaSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first even-row-color"><code>static double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInThetaSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../../tuple/AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../../tuple/JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../../tuple/JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Intersection.</span><code><a href="../../tuple/Intersection.html#intersect(org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a> summary)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Performs a stateful intersection of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary and rules + from the summarySetOps defined by the Intersection constructor.</div> +</div> +<div class="col-first even-row-color"><code><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../../tuple/Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a> summary)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the + result as an unordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../../tuple/JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../../tuple/AnotB.html#notB(org.apache.datasketches.theta.Sketch)" class="member-name-link">notB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../../tuple/JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../../tuple/Union.html#union(org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../../tuple/Union.html" title="type parameter in Union">S</a> summary)</code></div> +<div class="col-last even-row-color"> +<div class="block">Performs a stateful union of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../../tuple/Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../../tuple/Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union</a><wbr>(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../../tuple/Union.html" title="type parameter in Union">S</a>> tupleSketch, + <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../../tuple/Union.html" title="type parameter in Union">S</a> summary)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/Sketches.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/Sketches.html new file mode 100644 index 000000000..692551b65 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/Sketches.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.Sketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: Sketches"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Sketches.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.Sketches" class="title">Uses of Class<br>org.apache.datasketches.theta.Sketches</h1> +</div> +No usage of org.apache.datasketches.theta.Sketches</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/Union.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/Union.html new file mode 100644 index 000000000..aeda45dd0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/Union.html @@ -0,0 +1,110 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.Union (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: Union"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Union.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.Union" class="title">Uses of Class<br>org.apache.datasketches.theta.Union</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Union.html" title="class in org.apache.datasketches.theta">Union</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../Union.html" title="class in org.apache.datasketches.theta">Union</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../Union.html" title="class in org.apache.datasketches.theta">Union</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#buildUnion()" class="member-name-link">buildUnion</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="../../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> +</div> +<div class="col-first odd-row-color"><code><a href="../Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationBuilder.</span><code><a href="../SetOperationBuilder.html#buildUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Convenience method, returns a configured SetOperation Union with + <a href="../../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> + and the given destination memory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Convenience method, calls <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../Union.html" title="class in org.apache.datasketches.theta">Union</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Convenience method, calls <a href="../SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateReturnState.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateReturnState.html new file mode 100644 index 000000000..c144b9c6a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateReturnState.html @@ -0,0 +1,139 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.theta.UpdateReturnState (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, enum: UpdateReturnState"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.theta.UpdateReturnState" class="title">Uses of Enum Class<br>org.apache.datasketches.theta.UpdateReturnState</h1> +</div> +<div class="caption"><span>Packages that use <a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(byte%5B%5D)" class="member-name-link">update</a><wbr>(byte[] data)</code></div> +<div class="col-last even-row-color"> +<div class="block">Present this sketch with the given byte array.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(char%5B%5D)" class="member-name-link">update</a><wbr>(char[] data)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Present this sketch with the given char array.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(double)" class="member-name-link">update</a><wbr>(double datum)</code></div> +<div class="col-last even-row-color"> +<div class="block">Present this sketch with the given double (or float) datum.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(int%5B%5D)" class="member-name-link">update</a><wbr>(int[] data)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Present this sketch with the given integer array.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(long)" class="member-name-link">update</a><wbr>(long datum)</code></div> +<div class="col-last even-row-color"> +<div class="block">Present this sketch with a long.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(long%5B%5D)" class="member-name-link">update</a><wbr>(long[] data)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Present this sketch with the given long array.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(java.lang.String)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datum)</code></div> +<div class="col-last even-row-color"> +<div class="block">Present this sketch with the given String.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#update(java.nio.ByteBuffer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Present this sketch with the given ByteBuffer + If the ByteBuffer is null or empty, no update attempt is made and the method returns.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateReturnState.</span><code><a href="../UpdateReturnState.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateReturnState.</span><code><a href="../UpdateReturnState.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateSketch.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateSketch.html new file mode 100644 index 000000000..ebc347735 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateSketch.html @@ -0,0 +1,196 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.UpdateSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: UpdateSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.UpdateSketch" class="title">Uses of Class<br>org.apache.datasketches.theta.UpdateSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an UpdateSketch with the current configuration of this Builder + with the specified backing destination Memory store.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#buildLocal(org.apache.datasketches.theta.UpdateSketch)" class="member-name-link">buildLocal</a><wbr>(<a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> shared)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a local, on-heap, concurrent UpdateSketch to be used as a per-thread local buffer + along with the given concurrent shared UpdateSketch and the current configuration of this + Builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#buildShared()" class="member-name-link">buildShared</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an on-heap concurrent shared UpdateSketch with the current configuration of the + Builder.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#buildShared(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildShared</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder and the given destination WritableMemory.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#buildSharedFromSketch(org.apache.datasketches.theta.UpdateSketch,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildSharedFromSketch</a><wbr>(<a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> sketch, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder, the data from the given sketch, and the given destination + WritableMemory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyUpdateSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUpdateSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a></div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyUpdateSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUpdateSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long expectedSeed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a></div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#rebuild()" class="member-name-link">rebuild</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Rebuilds the hash table to remove dirty values or to reduce the size + to nominal entries.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUpdateSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a></div> +</div> +<div class="col-first even-row-color"><code>static <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUpdateSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long expectedSeed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Ref: <a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a></div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> with parameters of type <a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#buildLocal(org.apache.datasketches.theta.UpdateSketch)" class="member-name-link">buildLocal</a><wbr>(<a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> shared)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a local, on-heap, concurrent UpdateSketch to be used as a per-thread local buffer + along with the given concurrent shared UpdateSketch and the current configuration of this + Builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#buildSharedFromSketch(org.apache.datasketches.theta.UpdateSketch,org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildSharedFromSketch</a><wbr>(<a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> sketch, + org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current + configuration of the Builder, the data from the given sketch, and the given destination + WritableMemory.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateSketchBuilder.html new file mode 100644 index 000000000..88fb818b1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/class-use/UpdateSketchBuilder.html @@ -0,0 +1,148 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.theta.UpdateSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta, class: UpdateSketchBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.theta.UpdateSketchBuilder" class="title">Uses of Class<br>org.apache.datasketches.theta.UpdateSketchBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<h2>Uses of <a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final <a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketch.</span><code><a href="../UpdateSketch.html#builder()" class="member-name-link">builder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns a new builder</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setFamily(org.apache.datasketches.common.Family)" class="member-name-link">setFamily</a><wbr>(<a href="../../common/Family.html" title="enum class in org.apache.datasketches.common">Family</a> family)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Set the Family.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setLocalLogNominalEntries(int)" class="member-name-link">setLocalLogNominalEntries</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last even-row-color"> +<div class="block">Alternative method of setting the Nominal Entries for a local concurrent sketch from the + log_base2 value.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setLocalNominalEntries(int)" class="member-name-link">setLocalNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the Nominal Entries for the concurrent local sketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setLogNominalEntries(int)" class="member-name-link">setLogNominalEntries</a><wbr>(int lgNomEntries)</code></div> +<div class="col-last even-row-color"> +<div class="block">Alternative method of setting the Nominal Entries for this sketch from the log_base2 value.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)" class="member-name-link">setMemoryRequestServer</a><wbr>(org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Set the MemoryRequestServer</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color"> +<div class="block">Sets the Nominal Entries for this sketch.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setP(float)" class="member-name-link">setP</a><wbr>(float p)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the upfront uniform sampling probability, <i>p</i></div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setPropagateOrderedCompact(boolean)" class="member-name-link">setPropagateOrderedCompact</a><wbr>(boolean prop)</code></div> +<div class="col-last even-row-color"> +<div class="block">Sets the Propagate Ordered Compact flag to the given value.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Sets the cache Resize Factor.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdateSketchBuilder.</span><code><a href="../UpdateSketchBuilder.html#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#updateSketchBuilder()" class="member-name-link">updateSketchBuilder</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Ref: <a href="../UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/package-summary.html b/docs/7.0.X/org/apache/datasketches/theta/package-summary.html new file mode 100644 index 000000000..15feb74fb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/package-summary.html @@ -0,0 +1,168 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.theta (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.theta"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.theta" class="title">Package org.apache.datasketches.theta</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.theta</span></div> +<section class="package-description" id="package-description"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>. + + <p>There is a separate Tuple package for many of the sketches that are derived from the + same algorithms defined in the Theta Sketch Framework paper.</p></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BitPacking.html" title="class in org.apache.datasketches.theta">BitPacking</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Used as part of Theta compression.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The parent class of all the CompactSketches.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">This is used to iterate over the retained hash values of the Theta sketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The API for intersection operations</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Jaccard similarity of two Theta Sketches.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The parent API for all Set Operations</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">For building a new SetOperation.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The top-level class for all theta sketches.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This class brings together the common sketch and set operation creation methods and + the public static methods into one place.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Compute the union of two or more theta sketches.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="UpdateReturnState.html" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block"><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">For building a new UpdateSketch.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/package-tree.html b/docs/7.0.X/org/apache/datasketches/theta/package-tree.html new file mode 100644 index 000000000..b1824bccb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/package-tree.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.theta Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.theta"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.theta</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.theta.<a href="BitPacking.html" class="type-name-link" title="class in org.apache.datasketches.theta">BitPacking</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="JaccardSimilarity.html" class="type-name-link" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="SetOperation.html" class="type-name-link" title="class in org.apache.datasketches.theta">SetOperation</a> (implements org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a>) +<ul> +<li class="circle">org.apache.datasketches.theta.<a href="AnotB.html" class="type-name-link" title="class in org.apache.datasketches.theta">AnotB</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="Intersection.html" class="type-name-link" title="class in org.apache.datasketches.theta">Intersection</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="Union.html" class="type-name-link" title="class in org.apache.datasketches.theta">Union</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.theta.<a href="SetOperationBuilder.html" class="type-name-link" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="Sketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">Sketch</a> (implements org.apache.datasketches.common.<a href="../common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a>) +<ul> +<li class="circle">org.apache.datasketches.theta.<a href="CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">CompactSketch</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="UpdateSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketch</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.theta.<a href="Sketches.html" class="type-name-link" title="class in org.apache.datasketches.theta">Sketches</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="UpdateSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.theta.<a href="HashIterator.html" class="type-name-link" title="interface in org.apache.datasketches.theta">HashIterator</a></li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.theta.<a href="UpdateReturnState.html" class="type-name-link" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/theta/package-use.html b/docs/7.0.X/org/apache/datasketches/theta/package-use.html new file mode 100644 index 000000000..7dc27c1de --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/theta/package-use.html @@ -0,0 +1,166 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.theta (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.theta"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.theta" class="title">Uses of Package<br>org.apache.datasketches.theta</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.theta</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></div> +<div class="col-last even-row-color"> +<div class="block">The theta package contains the basic sketch classes that are members of the + <a href="../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.theta"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.theta</a> used by <a href="package-summary.html">org.apache.datasketches.theta</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/AnotB.html#org.apache.datasketches.theta">AnotB</a></div> +<div class="col-last even-row-color"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/CompactSketch.html#org.apache.datasketches.theta">CompactSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">The parent class of all the CompactSketches.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/HashIterator.html#org.apache.datasketches.theta">HashIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">This is used to iterate over the retained hash values of the Theta sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Intersection.html#org.apache.datasketches.theta">Intersection</a></div> +<div class="col-last odd-row-color"> +<div class="block">The API for intersection operations</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SetOperation.html#org.apache.datasketches.theta">SetOperation</a></div> +<div class="col-last even-row-color"> +<div class="block">The parent API for all Set Operations</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SetOperationBuilder.html#org.apache.datasketches.theta">SetOperationBuilder</a></div> +<div class="col-last odd-row-color"> +<div class="block">For building a new SetOperation.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.theta">Sketch</a></div> +<div class="col-last even-row-color"> +<div class="block">The top-level class for all theta sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Union.html#org.apache.datasketches.theta">Union</a></div> +<div class="col-last odd-row-color"> +<div class="block">Compute the union of two or more theta sketches.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/UpdateReturnState.html#org.apache.datasketches.theta">UpdateReturnState</a></div> +<div class="col-last even-row-color"> +<div class="block"><a href="../../../../resources/dictionary.html#updateReturnState">See Update Return State</a></div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdateSketch.html#org.apache.datasketches.theta">UpdateSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/UpdateSketchBuilder.html#org.apache.datasketches.theta">UpdateSketchBuilder</a></div> +<div class="col-last even-row-color"> +<div class="block">For building a new UpdateSketch.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.theta</a> used by <a href="../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.thetacommon">Sketch</a></div> +<div class="col-last even-row-color"> +<div class="block">The top-level class for all theta sketches.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.theta</a> used by <a href="../tuple/package-summary.html">org.apache.datasketches.tuple</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.tuple">Sketch</a></div> +<div class="col-last even-row-color"> +<div class="block">The top-level class for all theta sketches.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/BinomialBoundsN.html b/docs/7.0.X/org/apache/datasketches/thetacommon/BinomialBoundsN.html new file mode 100644 index 000000000..679234626 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/BinomialBoundsN.html @@ -0,0 +1,197 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BinomialBoundsN (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: BinomialBoundsN"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BinomialBoundsN.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Class BinomialBoundsN" class="title">Class BinomialBoundsN</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.thetacommon.BinomialBoundsN</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BinomialBoundsN</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class enables the estimation of error bounds given a sample set size, the sampling + probability theta, the number of standard deviations and a simple noDataSeen flag. This can + be used to estimate error bounds for fixed threshold sampling as well as the error bounds + calculations for sketches.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLowerBound(long,double,int,boolean)" class="member-name-link">getLowerBound</a><wbr>(long numSamples, + double theta, + int numSDev, + boolean noDataSeen)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the approximate lower bound value</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpperBound(long,double,int,boolean)" class="member-name-link">getUpperBound</a><wbr>(long numSamples, + double theta, + int numSDev, + boolean noDataSeen)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the approximate upper bound value</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getLowerBound(long,double,int,boolean)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(long numSamples, + double theta, + int numSDev, + boolean noDataSeen)</span></div> +<div class="block">Returns the approximate lower bound value</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numSamples</code> - the number of samples in the sample set</dd> +<dd><code>theta</code> - the sampling probability</dd> +<dd><code>numSDev</code> - the number of "standard deviations" from the mean for the tail bounds. + This must be an integer value of 1, 2 or 3.</dd> +<dd><code>noDataSeen</code> - this is normally false. However, in the case where you have zero samples + and a theta < 1.0, this flag enables the distinction between a virgin case when no actual + data has been seen and the case where the estimate may be zero but an upper error bound may + still exist.</dd> +<dt>Returns:</dt> +<dd>the approximate lower bound value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(long,double,int,boolean)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(long numSamples, + double theta, + int numSDev, + boolean noDataSeen)</span></div> +<div class="block">Returns the approximate upper bound value</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numSamples</code> - the number of samples in the sample set</dd> +<dd><code>theta</code> - the sampling probability</dd> +<dd><code>numSDev</code> - the number of "standard deviations" from the mean for the tail bounds. + This must be an integer value of 1, 2 or 3.</dd> +<dd><code>noDataSeen</code> - this is normally false. However, in the case where you have zero samples + and a theta < 1.0, this flag enables the distinction between a virgin case when no actual + data has been seen and the case where the estimate may be zero but an upper error bound may + still exist.</dd> +<dt>Returns:</dt> +<dd>the approximate upper bound value</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html b/docs/7.0.X/org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html new file mode 100644 index 000000000..cb328f995 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html @@ -0,0 +1,210 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BoundsOnRatiosInThetaSketchedSets (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: BoundsOnRatiosInThetaSketchedSets"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BoundsOnRatiosInThetaSketchedSets.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Class BoundsOnRatiosInThetaSketchedSets" class="title">Class BoundsOnRatiosInThetaSketchedSets</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.thetacommon.BoundsOnRatiosInThetaSketchedSets</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BoundsOnRatiosInThetaSketchedSets</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + <ul> + <li><i>A</i> is a Theta Sketch of population <i>PopA</i>.</li> + <li><i>B</i> is a Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Theta Sketch <i>C</i>, + which acts like a predicate or selection clause.</li> + <li>The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>).</li> + <li>The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>).</li> + <li>The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>).</li> + </ul> + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>. + If <i>B</i> is formed as an intersection of <i>A</i> and some other set <i>C</i>, + then the theta of <i>B</i> is guaranteed to be less than or equal to the theta of <i>B</i>.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Kevin Lang, Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLowerBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpperBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getLowerBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>getLowerBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getLowerBoundForBoverA</span><wbr><span class="parameters">(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the sketch A</dd> +<dd><code>sketchB</code> - the sketch B</dd> +<dt>Returns:</dt> +<dd>the approximate lower bound for B over A</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>getUpperBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getUpperBoundForBoverA</span><wbr><span class="parameters">(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the sketch A</dd> +<dd><code>sketchB</code> - the sketch B</dd> +<dt>Returns:</dt> +<dd>the approximate upper bound for B over A</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimateOfBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>getEstimateOfBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getEstimateOfBoverA</span><wbr><span class="parameters">(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Gets the estimate for B over A</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the sketch A</dd> +<dd><code>sketchB</code> - the sketch B</dd> +<dt>Returns:</dt> +<dd>the estimate for B over A</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html b/docs/7.0.X/org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html new file mode 100644 index 000000000..6fde97eb2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html @@ -0,0 +1,285 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>BoundsOnRatiosInTupleSketchedSets (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: BoundsOnRatiosInTupleSketchedSets"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/BoundsOnRatiosInTupleSketchedSets.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Class BoundsOnRatiosInTupleSketchedSets" class="title">Class BoundsOnRatiosInTupleSketchedSets</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.thetacommon.BoundsOnRatiosInTupleSketchedSets</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BoundsOnRatiosInTupleSketchedSets</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + <ul> + <li><i>A</i> is a Tuple Sketch of population <i>PopA</i>.</li> + <li><i>B</i> is a Tuple or Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Tuple or Theta Sketch <i>C</i>, + which acts like a predicate or selection clause.</li> + <li>The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>).</li> + <li>The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>).</li> + <li>The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>).</li> + </ul> + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>. + If <i>B</i> is formed as an intersection of <i>A</i> and some other set <i>C</i>, + then the theta of <i>B</i> is guaranteed to be less than or equal to the theta of <i>B</i>.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Kevin Lang, Lee Rhodes, David Cromberge</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"> +<h3>getLowerBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double</span> <span class="element-name">getLowerBoundForBoverA</span><wbr><span class="parameters">(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</span></div> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the Tuple sketch A with summary type <i>S</i></dd> +<dd><code>sketchB</code> - the Tuple sketch B with summary type <i>S</i></dd> +<dt>Returns:</dt> +<dd>the approximate lower bound for B over A</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>getLowerBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double</span> <span class="element-name">getLowerBoundForBoverA</span><wbr><span class="parameters">(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the Tuple sketch A with summary type <i>S</i></dd> +<dd><code>sketchB</code> - the Theta sketch B</dd> +<dt>Returns:</dt> +<dd>the approximate lower bound for B over A</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"> +<h3>getUpperBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double</span> <span class="element-name">getUpperBoundForBoverA</span><wbr><span class="parameters">(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</span></div> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the Tuple sketch A with summary type <i>S</i></dd> +<dd><code>sketchB</code> - the Tuple sketch B with summary type <i>S</i></dd> +<dt>Returns:</dt> +<dd>the approximate upper bound for B over A</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>getUpperBoundForBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double</span> <span class="element-name">getUpperBoundForBoverA</span><wbr><span class="parameters">(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the Tuple sketch A with summary type <i>S</i></dd> +<dd><code>sketchB</code> - the Theta sketch B</dd> +<dt>Returns:</dt> +<dd>the approximate upper bound for B over A</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"> +<h3>getEstimateOfBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double</span> <span class="element-name">getEstimateOfBoverA</span><wbr><span class="parameters">(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</span></div> +<div class="block">Gets the estimate for B over A</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the Tuple sketch A with summary type <i>S</i></dd> +<dd><code>sketchB</code> - the Tuple sketch B with summary type <i>S</i></dd> +<dt>Returns:</dt> +<dd>the estimate for B over A</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>getEstimateOfBoverA</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double</span> <span class="element-name">getEstimateOfBoverA</span><wbr><span class="parameters">(<a href="../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</span></div> +<div class="block">Gets the estimate for B over A</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - the Tuple sketch A with summary type <i>S</i></dd> +<dd><code>sketchB</code> - the Theta sketch B</dd> +<dt>Returns:</dt> +<dd>the estimate for B over A</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/HashOperations.html b/docs/7.0.X/org/apache/datasketches/thetacommon/HashOperations.html new file mode 100644 index 000000000..bb228c7b7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/HashOperations.html @@ -0,0 +1,534 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>HashOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: HashOperations"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/HashOperations.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Class HashOperations" class="title">Class HashOperations</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.thetacommon.HashOperations</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">HashOperations</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Helper class for the common hash table methods.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, Kevin Lang</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final int</code></div> +<div class="col-second even-row-color"><code><a href="#STRIDE_MASK" class="member-name-link">STRIDE_MASK</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The stride mask for the Open Address, Double Hashing (OADH) hash table algorithm.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkHashCorruption(long)" class="member-name-link">checkHashCorruption</a><wbr>(long hash)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkThetaCorruption(long)" class="member-name-link">checkThetaCorruption</a><wbr>(long thetaLong)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#continueCondition(long,long)" class="member-name-link">continueCondition</a><wbr>(long thetaLong, + long hash)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Return true (continue) if hash is greater than or equal to thetaLong, or if hash == 0, + or if hash == Long.MAX_VALUE.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#convertToHashTable(long%5B%5D,int,long,double)" class="member-name-link">convertToHashTable</a><wbr>(long[] hashArr, + int count, + long thetaLong, + double rebuildThreshold)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Converts the given array to a hash table.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#count(long%5B%5D,long)" class="member-name-link">count</a><wbr>(long[] srcArr, + long thetaLong)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Counts the cardinality of the given source array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#countPart(long%5B%5D,int,long)" class="member-name-link">countPart</a><wbr>(long[] srcArr, + int lgArrLongs, + long thetaLong)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Counts the cardinality of the first Log2 values of the given source array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashArrayInsert(long%5B%5D,long%5B%5D,int,long)" class="member-name-link">hashArrayInsert</a><wbr>(long[] srcArr, + long[] hashTable, + int lgArrLongs, + long thetaLong)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Inserts the given long array into the given OADH hashTable of the target size, + ignores duplicates and counts the values inserted.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashInsertOnly(long%5B%5D,int,long)" class="member-name-link">hashInsertOnly</a><wbr>(long[] hashTable, + int lgArrLongs, + long hash)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for on-heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashInsertOnlyMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)" class="member-name-link">hashInsertOnlyMemory</a><wbr>(org.apache.datasketches.memory.WritableMemory wmem, + int lgArrLongs, + long hash, + int memOffsetBytes)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashSearch(long%5B%5D,int,long)" class="member-name-link">hashSearch</a><wbr>(long[] hashTable, + int lgArrLongs, + long hash)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) search scheme for on-heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashSearchMemory(org.apache.datasketches.memory.Memory,int,long,int)" class="member-name-link">hashSearchMemory</a><wbr>(org.apache.datasketches.memory.Memory mem, + int lgArrLongs, + long hash, + int memOffsetBytes)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) search scheme for Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashSearchOrInsert(long%5B%5D,int,long)" class="member-name-link">hashSearchOrInsert</a><wbr>(long[] hashTable, + int lgArrLongs, + long hash)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for on-heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hashSearchOrInsertMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)" class="member-name-link">hashSearchOrInsertMemory</a><wbr>(org.apache.datasketches.memory.WritableMemory wmem, + int lgArrLongs, + long hash, + int memOffsetBytes)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash insert scheme, but inserts + values directly into a Memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#minLgHashTableSize(int,double)" class="member-name-link">minLgHashTableSize</a><wbr>(int count, + double rebuild_threshold)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the smallest log hash table size given the count of items and the rebuild threshold.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="STRIDE_MASK"> +<h3>STRIDE_MASK</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">STRIDE_MASK</span></div> +<div class="block">The stride mask for the Open Address, Double Hashing (OADH) hash table algorithm.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.HashOperations.STRIDE_MASK">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="hashSearch(long[],int,long)"> +<h3>hashSearch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">hashSearch</span><wbr><span class="parameters">(long[] hashTable, + int lgArrLongs, + long hash)</span></div> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) search scheme for on-heap. + Returns the index if found, -1 if not found.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hashTable</code> - The hash table to search. Its size must be a power of 2.</dd> +<dd><code>lgArrLongs</code> - The log_base2(hashTable.length). + <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.</dd> +<dd><code>hash</code> - The hash value to search for. It must not be zero.</dd> +<dt>Returns:</dt> +<dd>Current probe index if found, -1 if not found.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashInsertOnly(long[],int,long)"> +<h3>hashInsertOnly</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">hashInsertOnly</span><wbr><span class="parameters">(long[] hashTable, + int lgArrLongs, + long hash)</span></div> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for on-heap. + This method assumes that the input hash is not a duplicate. + Useful for rebuilding tables to avoid unnecessary comparisons. + Returns the index of insertion, which is always positive or zero. + Throws an exception if the table has no empty slot.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hashTable</code> - the hash table to insert into. Its size must be a power of 2.</dd> +<dd><code>lgArrLongs</code> - The log_base2(hashTable.length). + <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.</dd> +<dd><code>hash</code> - The hash value to be potentially inserted into an empty slot. It must not be zero.</dd> +<dt>Returns:</dt> +<dd>index of insertion. Always positive or zero.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashSearchOrInsert(long[],int,long)"> +<h3>hashSearchOrInsert</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">hashSearchOrInsert</span><wbr><span class="parameters">(long[] hashTable, + int lgArrLongs, + long hash)</span></div> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for on-heap. + Returns index ≥ 0 if found (duplicate); < 0 if inserted, inserted at -(index + 1). + Throws an exception if the value is not found and table has no empty slot.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hashTable</code> - The hash table to insert into. Its size must be a power of 2.</dd> +<dd><code>lgArrLongs</code> - The log_base2(hashTable.length). + <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.</dd> +<dd><code>hash</code> - The hash value to be potentially inserted into an empty slot only if it is not + a duplicate of any other hash value in the table. It must not be zero.</dd> +<dt>Returns:</dt> +<dd>index ≥ 0 if found (duplicate); < 0 if inserted, inserted at -(index + 1).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashArrayInsert(long[],long[],int,long)"> +<h3>hashArrayInsert</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">hashArrayInsert</span><wbr><span class="parameters">(long[] srcArr, + long[] hashTable, + int lgArrLongs, + long thetaLong)</span></div> +<div class="block">Inserts the given long array into the given OADH hashTable of the target size, + ignores duplicates and counts the values inserted. + The hash values must not be negative, zero values and values ≥ thetaLong are ignored. + The given hash table may have values, but they must have been inserted by this method or one + of the other OADH insert methods in this class. + This method performs additional checks against potentially invalid hash values or theta values. + Returns the count of values actually inserted.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcArr</code> - the source hash array to be potentially inserted</dd> +<dd><code>hashTable</code> - The hash table to insert into. Its size must be a power of 2.</dd> +<dd><code>lgArrLongs</code> - The log_base2(hashTable.length). + <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.</dd> +<dd><code>thetaLong</code> - The theta value that all input hash values are compared against. + It must greater than zero. + <a href="../../../../resources/dictionary.html#thetaLong">See Theta Long</a></dd> +<dt>Returns:</dt> +<dd>the count of values actually inserted</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashSearchMemory(org.apache.datasketches.memory.Memory,int,long,int)"> +<h3>hashSearchMemory</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">hashSearchMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + int lgArrLongs, + long hash, + int memOffsetBytes)</span></div> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) search scheme for Memory. + Returns the index if found, -1 if not found.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - The <i>Memory</i> containing the hash table to search. + The hash table portion must be a power of 2 in size.</dd> +<dd><code>lgArrLongs</code> - The log_base2(hashTable.length). + <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.</dd> +<dd><code>hash</code> - The hash value to search for. Must not be zero.</dd> +<dd><code>memOffsetBytes</code> - offset in the memory where the hashTable starts</dd> +<dt>Returns:</dt> +<dd>Current probe index if found, -1 if not found.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashInsertOnlyMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)"> +<h3>hashInsertOnlyMemory</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">hashInsertOnlyMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory wmem, + int lgArrLongs, + long hash, + int memOffsetBytes)</span></div> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash (OADH) insert scheme for Memory. + This method assumes that the input hash is not a duplicate. + Useful for rebuilding tables to avoid unnecessary comparisons. + Returns the index of insertion, which is always positive or zero. + Throws an exception if table has no empty slot.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>wmem</code> - The <i>WritableMemory</i> that contains the hashTable to insert into. + The size of the hashTable portion must be a power of 2.</dd> +<dd><code>lgArrLongs</code> - The log_base2(hashTable.length. + <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.</dd> +<dd><code>hash</code> - value that must not be zero and will be inserted into the array into an empty slot.</dd> +<dd><code>memOffsetBytes</code> - offset in the <i>WritableMemory</i> where the hashTable starts</dd> +<dt>Returns:</dt> +<dd>index of insertion. Always positive or zero.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashSearchOrInsertMemory(org.apache.datasketches.memory.WritableMemory,int,long,int)"> +<h3>hashSearchOrInsertMemory</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">hashSearchOrInsertMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory wmem, + int lgArrLongs, + long hash, + int memOffsetBytes)</span></div> +<div class="block">This is a classical Knuth-style Open Addressing, Double Hash insert scheme, but inserts + values directly into a Memory. + Returns index ≥ 0 if found (duplicate); < 0 if inserted, inserted at -(index + 1). + Throws an exception if the value is not found and table has no empty slot.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>wmem</code> - The <i>WritableMemory</i> that contains the hashTable to insert into.</dd> +<dd><code>lgArrLongs</code> - The log_base2(hashTable.length). + <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.</dd> +<dd><code>hash</code> - The hash value to be potentially inserted into an empty slot only if it is not + a duplicate of any other hash value in the table. It must not be zero.</dd> +<dd><code>memOffsetBytes</code> - offset in the <i>WritableMemory</i> where the hash array starts</dd> +<dt>Returns:</dt> +<dd>index ≥ 0 if found (duplicate); < 0 if inserted, inserted at -(index + 1).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkThetaCorruption(long)"> +<h3>checkThetaCorruption</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkThetaCorruption</span><wbr><span class="parameters">(long thetaLong)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - must be greater than zero otherwise throws an exception. + <a href="../../../../resources/dictionary.html#thetaLong">See Theta Long</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkHashCorruption(long)"> +<h3>checkHashCorruption</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkHashCorruption</span><wbr><span class="parameters">(long hash)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hash</code> - must be greater than -1 otherwise throws an exception. + Note a hash of zero is normally ignored, but a negative hash is never allowed.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="continueCondition(long,long)"> +<h3>continueCondition</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">continueCondition</span><wbr><span class="parameters">(long thetaLong, + long hash)</span></div> +<div class="block">Return true (continue) if hash is greater than or equal to thetaLong, or if hash == 0, + or if hash == Long.MAX_VALUE.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - must be greater than the hash value + <a href="../../../../resources/dictionary.html#thetaLong">See Theta Long</a></dd> +<dd><code>hash</code> - must be less than thetaLong and not less than or equal to zero.</dd> +<dt>Returns:</dt> +<dd>true (continue) if hash is greater than or equal to thetaLong, or if hash == 0, + or if hash == Long.MAX_VALUE.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="convertToHashTable(long[],int,long,double)"> +<h3>convertToHashTable</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long[]</span> <span class="element-name">convertToHashTable</span><wbr><span class="parameters">(long[] hashArr, + int count, + long thetaLong, + double rebuildThreshold)</span></div> +<div class="block">Converts the given array to a hash table.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hashArr</code> - The given array of hashes. Gaps are OK.</dd> +<dd><code>count</code> - The number of valid hashes in the array</dd> +<dd><code>thetaLong</code> - Any hashes equal to or greater than thetaLong will be ignored</dd> +<dd><code>rebuildThreshold</code> - The fill fraction for the hash table forcing a rebuild or resize.</dd> +<dt>Returns:</dt> +<dd>a HashTable</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="minLgHashTableSize(int,double)"> +<h3>minLgHashTableSize</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">minLgHashTableSize</span><wbr><span class="parameters">(int count, + double rebuild_threshold)</span></div> +<div class="block">Returns the smallest log hash table size given the count of items and the rebuild threshold.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>count</code> - the given count of items</dd> +<dd><code>rebuild_threshold</code> - the rebuild threshold as a fraction between zero and one.</dd> +<dt>Returns:</dt> +<dd>the smallest log hash table size</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="countPart(long[],int,long)"> +<h3>countPart</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">countPart</span><wbr><span class="parameters">(long[] srcArr, + int lgArrLongs, + long thetaLong)</span></div> +<div class="block">Counts the cardinality of the first Log2 values of the given source array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcArr</code> - the given source array</dd> +<dd><code>lgArrLongs</code> - <a href="../../../../resources/dictionary.html#lgArrLongs">See lgArrLongs</a></dd> +<dd><code>thetaLong</code> - <a href="../../../../resources/dictionary.html#thetaLong">See Theta Long</a></dd> +<dt>Returns:</dt> +<dd>the cardinality</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="count(long[],long)"> +<h3>count</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">count</span><wbr><span class="parameters">(long[] srcArr, + long thetaLong)</span></div> +<div class="block">Counts the cardinality of the given source array.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcArr</code> - the given source array</dd> +<dd><code>thetaLong</code> - <a href="../../../../resources/dictionary.html#thetaLong">See Theta Long</a></dd> +<dt>Returns:</dt> +<dd>the cardinality</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/QuickSelect.html b/docs/7.0.X/org/apache/datasketches/thetacommon/QuickSelect.html new file mode 100644 index 000000000..ec6a8c043 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/QuickSelect.html @@ -0,0 +1,303 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>QuickSelect (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: QuickSelect"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/QuickSelect.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Class QuickSelect" class="title">Class QuickSelect</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.thetacommon.QuickSelect</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">QuickSelect</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">QuickSelect algorithm improved from Sedgewick. Gets the kth order value + (1-based or 0-based) from the array. + Warning! This changes the ordering of elements in the given array!<br> + Also see:<br> + blog.teamleadnet.com/2012/07/quick-select-algorithm-find-kth-element.html<br> + See QuickSelectTest for examples and testNG tests.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#select(double%5B%5D,int,int,int)" class="member-name-link">select</a><wbr>(double[] arr, + int lo, + int hi, + int pivot)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the 0-based kth order statistic from the array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#select(long%5B%5D,int,int,int)" class="member-name-link">select</a><wbr>(long[] arr, + int lo, + int hi, + int pivot)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the 0-based kth order statistic from the array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#selectExcludingZeros(double%5B%5D,int,int)" class="member-name-link">selectExcludingZeros</a><wbr>(double[] arr, + int nonZeros, + int pivot)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the + array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#selectExcludingZeros(long%5B%5D,int,int)" class="member-name-link">selectExcludingZeros</a><wbr>(long[] arr, + int nonZeros, + int pivot)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the + array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#selectIncludingZeros(double%5B%5D,int)" class="member-name-link">selectIncludingZeros</a><wbr>(double[] arr, + int pivot)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the + array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#selectIncludingZeros(long%5B%5D,int)" class="member-name-link">selectIncludingZeros</a><wbr>(long[] arr, + int pivot)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the + array.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="select(long[],int,int,int)"> +<h3>select</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">select</span><wbr><span class="parameters">(long[] arr, + int lo, + int hi, + int pivot)</span></div> +<div class="block">Gets the 0-based kth order statistic from the array. Warning! This changes the ordering + of elements in the given array!</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The array to be re-arranged.</dd> +<dd><code>lo</code> - The lowest 0-based index to be considered.</dd> +<dd><code>hi</code> - The highest 0-based index to be considered.</dd> +<dd><code>pivot</code> - The 0-based index of the value to pivot on.</dd> +<dt>Returns:</dt> +<dd>The value of the smallest (n)th element where n is 0-based.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="selectIncludingZeros(long[],int)"> +<h3>selectIncludingZeros</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">selectIncludingZeros</span><wbr><span class="parameters">(long[] arr, + int pivot)</span></div> +<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the + array. Warning! This changes the ordering of elements in the given array!</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The hash array.</dd> +<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array. + After the operation all values below this 1-based index will be less than this value + and all values above this index will be greater. The 0-based index of the pivot will be + pivot-1.</dd> +<dt>Returns:</dt> +<dd>The value of the smallest (N)th element including zeros, where N is 1-based.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="selectExcludingZeros(long[],int,int)"> +<h3>selectExcludingZeros</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">selectExcludingZeros</span><wbr><span class="parameters">(long[] arr, + int nonZeros, + int pivot)</span></div> +<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the + array. Warning! This changes the ordering of elements in the given array!</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The hash array.</dd> +<dd><code>nonZeros</code> - The number of non-zero values in the array.</dd> +<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array. + After the operation all values below this 1-based index will be less than this value + and all values above this index will be greater. The 0-based index of the pivot will be + pivot+arr.length-nonZeros-1.</dd> +<dt>Returns:</dt> +<dd>The value of the smallest (N)th element excluding zeros, where N is 1-based.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="select(double[],int,int,int)"> +<h3>select</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">select</span><wbr><span class="parameters">(double[] arr, + int lo, + int hi, + int pivot)</span></div> +<div class="block">Gets the 0-based kth order statistic from the array. Warning! This changes the ordering + of elements in the given array!</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The array to be re-arranged.</dd> +<dd><code>lo</code> - The lowest 0-based index to be considered.</dd> +<dd><code>hi</code> - The highest 0-based index to be considered.</dd> +<dd><code>pivot</code> - The 0-based smallest value to pivot on.</dd> +<dt>Returns:</dt> +<dd>The value of the smallest (n)th element where n is 0-based.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="selectIncludingZeros(double[],int)"> +<h3>selectIncludingZeros</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">selectIncludingZeros</span><wbr><span class="parameters">(double[] arr, + int pivot)</span></div> +<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the + array. Warning! This changes the ordering of elements in the given array!</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The hash array.</dd> +<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array. + After the operation all values below this 1-based index will be less than this value + and all values above this index will be greater. The 0-based index of the pivot will be + pivot-1.</dd> +<dt>Returns:</dt> +<dd>The value of the smallest (N)th element including zeros, where N is 1-based.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="selectExcludingZeros(double[],int,int)"> +<h3>selectExcludingZeros</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">selectExcludingZeros</span><wbr><span class="parameters">(double[] arr, + int nonZeros, + int pivot)</span></div> +<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the + array. Warning! This changes the ordering of elements in the given array!</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>arr</code> - The hash array.</dd> +<dd><code>nonZeros</code> - The number of non-zero values in the array.</dd> +<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array. + After the operation all values below this 1-based index will be less than this value + and all values above this index will be greater. The 0-based index of the pivot will be + pivot+arr.length-nonZeros-1.</dd> +<dt>Returns:</dt> +<dd>The value of the smallest (N)th element excluding zeros, where N is 1-based.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html new file mode 100644 index 000000000..6ead94612 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html @@ -0,0 +1,309 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SetOperationCornerCases.AnotbAction (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: AnotbAction"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SetOperationCornerCases.AnotbAction.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Enum Class SetOperationCornerCases.AnotbAction" class="title">Enum Class SetOperationCornerCases.AnotbAction</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a>> +<div class="inheritance">org.apache.datasketches.thetacommon.SetOperationCornerCases.AnotbAction</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">SetOperationCornerCases.AnotbAction</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a>></span></div> +<div class="block">A not B actions</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#DEGEN_MIN_0_F" class="member-name-link">DEGEN_MIN_0_F</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</div> +<div class="col-first odd-row-color"><code><a href="#DEGEN_THA_0_F" class="member-name-link">DEGEN_THA_0_F</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Degenerate{ThetaA, 0, F}</div> +</div> +<div class="col-first even-row-color"><code><a href="#EMPTY_1_0_T" class="member-name-link">EMPTY_1_0_T</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Empty{1.0, 0, T}</div> +</div> +<div class="col-first odd-row-color"><code><a href="#FULL_ANOTB" class="member-name-link">FULL_ANOTB</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Full AnotB</div> +</div> +<div class="col-first even-row-color"><code><a href="#SKETCH_A" class="member-name-link">SKETCH_A</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Sketch A Exact</div> +</div> +<div class="col-first odd-row-color"><code><a href="#TRIM_A" class="member-name-link">TRIM_A</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Trim Sketch A by MinTheta</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActionDescription()" class="member-name-link">getActionDescription</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the action description</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActionId()" class="member-name-link">getActionId</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Action ID</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="SKETCH_A"> +<h3>SKETCH_A</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">SKETCH_A</span></div> +<div class="block">Sketch A Exact</div> +</section> +</li> +<li> +<section class="detail" id="TRIM_A"> +<h3>TRIM_A</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">TRIM_A</span></div> +<div class="block">Trim Sketch A by MinTheta</div> +</section> +</li> +<li> +<section class="detail" id="DEGEN_MIN_0_F"> +<h3>DEGEN_MIN_0_F</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">DEGEN_MIN_0_F</span></div> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</section> +</li> +<li> +<section class="detail" id="DEGEN_THA_0_F"> +<h3>DEGEN_THA_0_F</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">DEGEN_THA_0_F</span></div> +<div class="block">Degenerate{ThetaA, 0, F}</div> +</section> +</li> +<li> +<section class="detail" id="EMPTY_1_0_T"> +<h3>EMPTY_1_0_T</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">EMPTY_1_0_T</span></div> +<div class="block">Empty{1.0, 0, T}</div> +</section> +</li> +<li> +<section class="detail" id="FULL_ANOTB"> +<h3>FULL_ANOTB</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">FULL_ANOTB</span></div> +<div class="block">Full AnotB</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getActionId()"> +<h3>getActionId</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getActionId</span>()</div> +<div class="block">Gets the Action ID</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the actionId</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getActionDescription()"> +<h3>getActionDescription</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getActionDescription</span>()</div> +<div class="block">Gets the action description</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the action description</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html new file mode 100644 index 000000000..718386bb1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html @@ -0,0 +1,485 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SetOperationCornerCases.CornerCase (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: CornerCase"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SetOperationCornerCases.CornerCase.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Enum Class SetOperationCornerCases.CornerCase" class="title">Enum Class SetOperationCornerCases.CornerCase</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a>> +<div class="inheritance">org.apache.datasketches.thetacommon.SetOperationCornerCases.CornerCase</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">SetOperationCornerCases.CornerCase</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a>></span></div> +<div class="block">List of corner cases</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#Degen_Degen" class="member-name-link">Degen_Degen</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Degen_Degen</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Degen_Empty" class="member-name-link">Degen_Empty</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Degen_Empty</div> +</div> +<div class="col-first even-row-color"><code><a href="#Degen_Estimation" class="member-name-link">Degen_Estimation</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Degen_Estimation</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Degen_Exact" class="member-name-link">Degen_Exact</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Degen_Exact</div> +</div> +<div class="col-first even-row-color"><code><a href="#Empty_Degen" class="member-name-link">Empty_Degen</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Empty Degen</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Empty_Empty" class="member-name-link">Empty_Empty</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Empty Empty</div> +</div> +<div class="col-first even-row-color"><code><a href="#Empty_Estimation" class="member-name-link">Empty_Estimation</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Empty Estimation</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Empty_Exact" class="member-name-link">Empty_Exact</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Empty Exact</div> +</div> +<div class="col-first even-row-color"><code><a href="#Estimation_Degen" class="member-name-link">Estimation_Degen</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Estimation_Degen</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Estimation_Empty" class="member-name-link">Estimation_Empty</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Estimation_Empty</div> +</div> +<div class="col-first even-row-color"><code><a href="#Estimation_Estimation" class="member-name-link">Estimation_Estimation</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Estimation_Estimation</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Estimation_Exact" class="member-name-link">Estimation_Exact</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Estimation_Exact</div> +</div> +<div class="col-first even-row-color"><code><a href="#Exact_Degen" class="member-name-link">Exact_Degen</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Exact Degen</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Exact_Empty" class="member-name-link">Exact_Empty</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Exact Empty</div> +</div> +<div class="col-first even-row-color"><code><a href="#Exact_Estimation" class="member-name-link">Exact_Estimation</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Exact Estimation</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Exact_Exact" class="member-name-link">Exact_Exact</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Exact Exact</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#caseIdToCornerCase(int)" class="member-name-link">caseIdToCornerCase</a><wbr>(int id)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Converts caseId to CornerCaseId</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAnotbAction()" class="member-name-link">getAnotbAction</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the AnotB action</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCaseDescription()" class="member-name-link">getCaseDescription</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the case description</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getId()" class="member-name-link">getId</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the case ID</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIntersectAction()" class="member-name-link">getIntersectAction</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the intersect action</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnionAction()" class="member-name-link">getUnionAction</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the union action</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="Empty_Empty"> +<h3>Empty_Empty</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Empty_Empty</span></div> +<div class="block">Empty Empty</div> +</section> +</li> +<li> +<section class="detail" id="Empty_Exact"> +<h3>Empty_Exact</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Empty_Exact</span></div> +<div class="block">Empty Exact</div> +</section> +</li> +<li> +<section class="detail" id="Empty_Estimation"> +<h3>Empty_Estimation</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Empty_Estimation</span></div> +<div class="block">Empty Estimation</div> +</section> +</li> +<li> +<section class="detail" id="Empty_Degen"> +<h3>Empty_Degen</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Empty_Degen</span></div> +<div class="block">Empty Degen</div> +</section> +</li> +<li> +<section class="detail" id="Exact_Empty"> +<h3>Exact_Empty</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Exact_Empty</span></div> +<div class="block">Exact Empty</div> +</section> +</li> +<li> +<section class="detail" id="Exact_Exact"> +<h3>Exact_Exact</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Exact_Exact</span></div> +<div class="block">Exact Exact</div> +</section> +</li> +<li> +<section class="detail" id="Exact_Estimation"> +<h3>Exact_Estimation</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Exact_Estimation</span></div> +<div class="block">Exact Estimation</div> +</section> +</li> +<li> +<section class="detail" id="Exact_Degen"> +<h3>Exact_Degen</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Exact_Degen</span></div> +<div class="block">Exact Degen</div> +</section> +</li> +<li> +<section class="detail" id="Estimation_Empty"> +<h3>Estimation_Empty</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Estimation_Empty</span></div> +<div class="block">Estimation_Empty</div> +</section> +</li> +<li> +<section class="detail" id="Estimation_Exact"> +<h3>Estimation_Exact</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Estimation_Exact</span></div> +<div class="block">Estimation_Exact</div> +</section> +</li> +<li> +<section class="detail" id="Estimation_Estimation"> +<h3>Estimation_Estimation</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Estimation_Estimation</span></div> +<div class="block">Estimation_Estimation</div> +</section> +</li> +<li> +<section class="detail" id="Estimation_Degen"> +<h3>Estimation_Degen</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Estimation_Degen</span></div> +<div class="block">Estimation_Degen</div> +</section> +</li> +<li> +<section class="detail" id="Degen_Empty"> +<h3>Degen_Empty</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Degen_Empty</span></div> +<div class="block">Degen_Empty</div> +</section> +</li> +<li> +<section class="detail" id="Degen_Exact"> +<h3>Degen_Exact</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Degen_Exact</span></div> +<div class="block">Degen_Exact</div> +</section> +</li> +<li> +<section class="detail" id="Degen_Estimation"> +<h3>Degen_Estimation</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Degen_Estimation</span></div> +<div class="block">Degen_Estimation</div> +</section> +</li> +<li> +<section class="detail" id="Degen_Degen"> +<h3>Degen_Degen</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">Degen_Degen</span></div> +<div class="block">Degen_Degen</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getId()"> +<h3>getId</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getId</span>()</div> +<div class="block">Gets the case ID</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the caseId</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCaseDescription()"> +<h3>getCaseDescription</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getCaseDescription</span>()</div> +<div class="block">Gets the case description</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the caseDescription</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getIntersectAction()"> +<h3>getIntersectAction</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></span> <span class="element-name">getIntersectAction</span>()</div> +<div class="block">Gets the intersect action</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the intersectAction</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getAnotbAction()"> +<h3>getAnotbAction</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span> <span class="element-name">getAnotbAction</span>()</div> +<div class="block">Gets the AnotB action</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the anotbAction</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUnionAction()"> +<h3>getUnionAction</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">getUnionAction</span>()</div> +<div class="block">Gets the union action</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the unionAction</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="caseIdToCornerCase(int)"> +<h3>caseIdToCornerCase</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span> <span class="element-name">caseIdToCornerCase</span><wbr><span class="parameters">(int id)</span></div> +<div class="block">Converts caseId to CornerCaseId</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>id</code> - the case ID</dd> +<dt>Returns:</dt> +<dd>the Corner Case ID</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html new file mode 100644 index 000000000..eb373e8d7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html @@ -0,0 +1,276 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SetOperationCornerCases.IntersectAction (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: IntersectAction"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SetOperationCornerCases.IntersectAction.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Enum Class SetOperationCornerCases.IntersectAction" class="title">Enum Class SetOperationCornerCases.IntersectAction</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a>> +<div class="inheritance">org.apache.datasketches.thetacommon.SetOperationCornerCases.IntersectAction</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">SetOperationCornerCases.IntersectAction</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a>></span></div> +<div class="block">Intersection actions</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#DEGEN_MIN_0_F" class="member-name-link">DEGEN_MIN_0_F</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</div> +<div class="col-first odd-row-color"><code><a href="#EMPTY_1_0_T" class="member-name-link">EMPTY_1_0_T</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Empty{1.0, 0, T</div> +</div> +<div class="col-first even-row-color"><code><a href="#FULL_INTERSECT" class="member-name-link">FULL_INTERSECT</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Full Intersect</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActionDescription()" class="member-name-link">getActionDescription</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Action Description</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActionId()" class="member-name-link">getActionId</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Action ID</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DEGEN_MIN_0_F"> +<h3>DEGEN_MIN_0_F</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></span> <span class="element-name">DEGEN_MIN_0_F</span></div> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</section> +</li> +<li> +<section class="detail" id="EMPTY_1_0_T"> +<h3>EMPTY_1_0_T</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></span> <span class="element-name">EMPTY_1_0_T</span></div> +<div class="block">Empty{1.0, 0, T</div> +</section> +</li> +<li> +<section class="detail" id="FULL_INTERSECT"> +<h3>FULL_INTERSECT</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></span> <span class="element-name">FULL_INTERSECT</span></div> +<div class="block">Full Intersect</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getActionId()"> +<h3>getActionId</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getActionId</span>()</div> +<div class="block">Gets the Action ID</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the actionId</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getActionDescription()"> +<h3>getActionDescription</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getActionDescription</span>()</div> +<div class="block">Gets the Action Description</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the actionDescription</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html new file mode 100644 index 000000000..83873d161 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html @@ -0,0 +1,342 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SetOperationCornerCases.UnionAction (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: UnionAction"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SetOperationCornerCases.UnionAction.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Enum Class SetOperationCornerCases.UnionAction" class="title">Enum Class SetOperationCornerCases.UnionAction</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a>> +<div class="inheritance">org.apache.datasketches.thetacommon.SetOperationCornerCases.UnionAction</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">SetOperationCornerCases.UnionAction</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a>></span></div> +<div class="block">List of union actions</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#DEGEN_MIN_0_F" class="member-name-link">DEGEN_MIN_0_F</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</div> +<div class="col-first odd-row-color"><code><a href="#DEGEN_THA_0_F" class="member-name-link">DEGEN_THA_0_F</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Degenerate{ThetaA, 0, F}</div> +</div> +<div class="col-first even-row-color"><code><a href="#DEGEN_THB_0_F" class="member-name-link">DEGEN_THB_0_F</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Degenerate{ThetaB, 0, F}</div> +</div> +<div class="col-first odd-row-color"><code><a href="#EMPTY_1_0_T" class="member-name-link">EMPTY_1_0_T</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Empty{1.0, 0, T}</div> +</div> +<div class="col-first even-row-color"><code><a href="#FULL_UNION" class="member-name-link">FULL_UNION</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Full Union</div> +</div> +<div class="col-first odd-row-color"><code><a href="#SKETCH_A" class="member-name-link">SKETCH_A</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Sketch A Exactly</div> +</div> +<div class="col-first even-row-color"><code><a href="#SKETCH_B" class="member-name-link">SKETCH_B</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Sketch B Exactly</div> +</div> +<div class="col-first odd-row-color"><code><a href="#TRIM_A" class="member-name-link">TRIM_A</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Trim Sketch A by MinTheta</div> +</div> +<div class="col-first even-row-color"><code><a href="#TRIM_B" class="member-name-link">TRIM_B</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Trim Sketch B by MinTheta</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActionDescription()" class="member-name-link">getActionDescription</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the action description</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActionId()" class="member-name-link">getActionId</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the action ID</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="SKETCH_A"> +<h3>SKETCH_A</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">SKETCH_A</span></div> +<div class="block">Sketch A Exactly</div> +</section> +</li> +<li> +<section class="detail" id="TRIM_A"> +<h3>TRIM_A</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">TRIM_A</span></div> +<div class="block">Trim Sketch A by MinTheta</div> +</section> +</li> +<li> +<section class="detail" id="SKETCH_B"> +<h3>SKETCH_B</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">SKETCH_B</span></div> +<div class="block">Sketch B Exactly</div> +</section> +</li> +<li> +<section class="detail" id="TRIM_B"> +<h3>TRIM_B</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">TRIM_B</span></div> +<div class="block">Trim Sketch B by MinTheta</div> +</section> +</li> +<li> +<section class="detail" id="DEGEN_MIN_0_F"> +<h3>DEGEN_MIN_0_F</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">DEGEN_MIN_0_F</span></div> +<div class="block">Degenerate{MinTheta, 0, F}</div> +</section> +</li> +<li> +<section class="detail" id="DEGEN_THA_0_F"> +<h3>DEGEN_THA_0_F</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">DEGEN_THA_0_F</span></div> +<div class="block">Degenerate{ThetaA, 0, F}</div> +</section> +</li> +<li> +<section class="detail" id="DEGEN_THB_0_F"> +<h3>DEGEN_THB_0_F</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">DEGEN_THB_0_F</span></div> +<div class="block">Degenerate{ThetaB, 0, F}</div> +</section> +</li> +<li> +<section class="detail" id="EMPTY_1_0_T"> +<h3>EMPTY_1_0_T</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">EMPTY_1_0_T</span></div> +<div class="block">Empty{1.0, 0, T}</div> +</section> +</li> +<li> +<section class="detail" id="FULL_UNION"> +<h3>FULL_UNION</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">FULL_UNION</span></div> +<div class="block">Full Union</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getActionId()"> +<h3>getActionId</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getActionId</span>()</div> +<div class="block">Gets the action ID</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the actionId</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getActionDescription()"> +<h3>getActionDescription</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getActionDescription</span>()</div> +<div class="block">Gets the action description</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the actionDescription</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.html b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.html new file mode 100644 index 000000000..f1c5f9994 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/SetOperationCornerCases.html @@ -0,0 +1,248 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SetOperationCornerCases (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SetOperationCornerCases.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Class SetOperationCornerCases" class="title">Class SetOperationCornerCases</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.thetacommon.SetOperationCornerCases</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SetOperationCornerCases</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Simplifies and speeds up set operations by resolving specific corner cases.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="SetOperationCornerCases.AnotbAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A not B actions</div> +</div> +<div class="col-first odd-row-color"><code>static enum </code></div> +<div class="col-second odd-row-color"><code><a href="SetOperationCornerCases.CornerCase.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">List of corner cases</div> +</div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="SetOperationCornerCases.IntersectAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Intersection actions</div> +</div> +<div class="col-first odd-row-color"><code>static enum </code></div> +<div class="col-second odd-row-color"><code><a href="SetOperationCornerCases.UnionAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">List of union actions</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SetOperationCornerCases</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createCornerCaseId(long,int,boolean,long,int,boolean)" class="member-name-link">createCornerCaseId</a><wbr>(long thetaLongA, + int countA, + boolean emptyA, + long thetaLongB, + int countB, + boolean emptyB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates the CornerCase ID</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sketchStateId(boolean,int,long)" class="member-name-link">sketchStateId</a><wbr>(boolean isEmpty, + int numRetained, + long thetaLong)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the sketch state ID</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>SetOperationCornerCases</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SetOperationCornerCases</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="createCornerCaseId(long,int,boolean,long,int,boolean)"> +<h3>createCornerCaseId</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">createCornerCaseId</span><wbr><span class="parameters">(long thetaLongA, + int countA, + boolean emptyA, + long thetaLongB, + int countB, + boolean emptyB)</span></div> +<div class="block">Creates the CornerCase ID</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>thetaLongA</code> - the theta of A as a long</dd> +<dd><code>countA</code> - the count of A</dd> +<dd><code>emptyA</code> - true if A is empty</dd> +<dd><code>thetaLongB</code> - the theta of B as a long</dd> +<dd><code>countB</code> - the count of B</dd> +<dd><code>emptyB</code> - true if B is empty</dd> +<dt>Returns:</dt> +<dd>the Corner Case ID</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="sketchStateId(boolean,int,long)"> +<h3>sketchStateId</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">sketchStateId</span><wbr><span class="parameters">(boolean isEmpty, + int numRetained, + long thetaLong)</span></div> +<div class="block">Returns the sketch state ID</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>isEmpty</code> - true if empty</dd> +<dd><code>numRetained</code> - the number of items retained</dd> +<dd><code>thetaLong</code> - the value of theta as a long</dd> +<dt>Returns:</dt> +<dd>the sketch state ID</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/ThetaUtil.html b/docs/7.0.X/org/apache/datasketches/thetacommon/ThetaUtil.html new file mode 100644 index 000000000..b48135233 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/ThetaUtil.html @@ -0,0 +1,404 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ThetaUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon, class: ThetaUtil"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ThetaUtil.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.thetacommon</a></div> +<h1 title="Class ThetaUtil" class="title">Class ThetaUtil</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.thetacommon.ThetaUtil</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ThetaUtil</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Utility methods for the Theta Family of sketches</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final int</code></div> +<div class="col-second even-row-color"><code><a href="#DEFAULT_NOMINAL_ENTRIES" class="member-name-link">DEFAULT_NOMINAL_ENTRIES</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The default nominal entries is provided as a convenience for those cases where the + nominal sketch size in number of entries is not provided.</div> +</div> +<div class="col-first odd-row-color"><code>static final long</code></div> +<div class="col-second odd-row-color"><code><a href="#DEFAULT_UPDATE_SEED" class="member-name-link">DEFAULT_UPDATE_SEED</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The seed 9001 used in the sketch update methods is a prime number that + was chosen very early on in experimental testing.</div> +</div> +<div class="col-first even-row-color"><code>static final int</code></div> +<div class="col-second even-row-color"><code><a href="#MAX_LG_NOM_LONGS" class="member-name-link">MAX_LG_NOM_LONGS</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The largest Log2 nom entries allowed: 26.</div> +</div> +<div class="col-first odd-row-color"><code>static final int</code></div> +<div class="col-second odd-row-color"><code><a href="#MIN_LG_ARR_LONGS" class="member-name-link">MIN_LG_ARR_LONGS</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The smallest Log2 cache size allowed: 5.</div> +</div> +<div class="col-first even-row-color"><code>static final int</code></div> +<div class="col-second even-row-color"><code><a href="#MIN_LG_NOM_LONGS" class="member-name-link">MIN_LG_NOM_LONGS</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The smallest Log2 nom entries allowed: 4.</div> +</div> +<div class="col-first odd-row-color"><code>static final double</code></div> +<div class="col-second odd-row-color"><code><a href="#REBUILD_THRESHOLD" class="member-name-link">REBUILD_THRESHOLD</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The hash table rebuild threshold = 15.0/16.0.</div> +</div> +<div class="col-first even-row-color"><code>static final double</code></div> +<div class="col-second even-row-color"><code><a href="#RESIZE_THRESHOLD" class="member-name-link">RESIZE_THRESHOLD</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The resize threshold = 0.5; tuned for speed.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkNomLongs(int)" class="member-name-link">checkNomLongs</a><wbr>(int nomLongs)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks that the given nomLongs is within bounds and returns the Log2 of the ceiling power of 2 + of the given nomLongs.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static short</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkSeedHashes(short,short)" class="member-name-link">checkSeedHashes</a><wbr>(short seedHashA, + short seedHashB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Check if the two seed hashes are equal.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static short</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeSeedHash(long)" class="member-name-link">computeSeedHash</a><wbr>(long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes and checks the 16-bit seed hash from the given long seed.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#startingSubMultiple(int,int,int)" class="member-name-link">startingSubMultiple</a><wbr>(int lgTarget, + int lgRF, + int lgMin)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the smallest allowed exponent of 2 that it is a sub-multiple of the target by zero, + one or more resize factors.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="MIN_LG_NOM_LONGS"> +<h3>MIN_LG_NOM_LONGS</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">MIN_LG_NOM_LONGS</span></div> +<div class="block">The smallest Log2 nom entries allowed: 4.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.ThetaUtil.MIN_LG_NOM_LONGS">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="MAX_LG_NOM_LONGS"> +<h3>MAX_LG_NOM_LONGS</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">MAX_LG_NOM_LONGS</span></div> +<div class="block">The largest Log2 nom entries allowed: 26.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.ThetaUtil.MAX_LG_NOM_LONGS">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="REBUILD_THRESHOLD"> +<h3>REBUILD_THRESHOLD</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">REBUILD_THRESHOLD</span></div> +<div class="block">The hash table rebuild threshold = 15.0/16.0.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.ThetaUtil.REBUILD_THRESHOLD">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="RESIZE_THRESHOLD"> +<h3>RESIZE_THRESHOLD</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">RESIZE_THRESHOLD</span></div> +<div class="block">The resize threshold = 0.5; tuned for speed.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.ThetaUtil.RESIZE_THRESHOLD">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="DEFAULT_NOMINAL_ENTRIES"> +<h3>DEFAULT_NOMINAL_ENTRIES</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_NOMINAL_ENTRIES</span></div> +<div class="block">The default nominal entries is provided as a convenience for those cases where the + nominal sketch size in number of entries is not provided. + A sketch of 4096 entries has a Relative Standard Error (RSE) of +/- 1.56% at a confidence of + 68%; or equivalently, a Relative Error of +/- 3.1% at a confidence of 95.4%. + <a href="../../../../resources/dictionary.html#defaultNomEntries">See Default Nominal Entries</a></div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.ThetaUtil.DEFAULT_NOMINAL_ENTRIES">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="DEFAULT_UPDATE_SEED"> +<h3>DEFAULT_UPDATE_SEED</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name">DEFAULT_UPDATE_SEED</span></div> +<div class="block">The seed 9001 used in the sketch update methods is a prime number that + was chosen very early on in experimental testing. Choosing a seed is somewhat arbitrary, and + the author cannot prove that this particular seed is somehow superior to other seeds. There + was some early Internet discussion that a seed of 0 did not produce as clean avalanche diagrams + as non-zero seeds, but this may have been more related to the MurmurHash2 release, which did + have some issues. As far as the author can determine, MurmurHash3 does not have these problems. + + <p>In order to perform set operations on two sketches it is critical that the same hash + function and seed are identical for both sketches, otherwise the assumed 1:1 relationship + between the original source key value and the hashed bit string would be violated. Once + you have developed a history of stored sketches you are stuck with it. + + <p><b>WARNING:</b> This seed is used internally by library sketches in different + packages and thus must be declared public. However, this seed value must not be used by library + users with the MurmurHash3 function. It should be viewed as existing for exclusive, private + use by the library. + + <p><a href="../../../../resources/dictionary.html#defaultUpdateSeed">See Default Update Seed</a></div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.ThetaUtil.DEFAULT_UPDATE_SEED">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="MIN_LG_ARR_LONGS"> +<h3>MIN_LG_ARR_LONGS</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">MIN_LG_ARR_LONGS</span></div> +<div class="block">The smallest Log2 cache size allowed: 5.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../constant-values.html#org.apache.datasketches.thetacommon.ThetaUtil.MIN_LG_ARR_LONGS">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="checkSeedHashes(short,short)"> +<h3>checkSeedHashes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">short</span> <span class="element-name">checkSeedHashes</span><wbr><span class="parameters">(short seedHashA, + short seedHashB)</span></div> +<div class="block">Check if the two seed hashes are equal. If not, throw an SketchesArgumentException.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seedHashA</code> - the seedHash A</dd> +<dd><code>seedHashB</code> - the seedHash B</dd> +<dt>Returns:</dt> +<dd>seedHashA if they are equal</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="computeSeedHash(long)"> +<h3>computeSeedHash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">short</span> <span class="element-name">computeSeedHash</span><wbr><span class="parameters">(long seed)</span></div> +<div class="block">Computes and checks the 16-bit seed hash from the given long seed. + The seed hash may not be zero in order to maintain compatibility with older serialized + versions that did not have this concept.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seed</code> - <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a></dd> +<dt>Returns:</dt> +<dd>the seed hash.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="startingSubMultiple(int,int,int)"> +<h3>startingSubMultiple</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">startingSubMultiple</span><wbr><span class="parameters">(int lgTarget, + int lgRF, + int lgMin)</span></div> +<div class="block">Gets the smallest allowed exponent of 2 that it is a sub-multiple of the target by zero, + one or more resize factors.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgTarget</code> - Log2 of the target size</dd> +<dd><code>lgRF</code> - Log_base2 of Resize Factor. + <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> +<dd><code>lgMin</code> - Log2 of the minimum allowed starting size</dd> +<dt>Returns:</dt> +<dd>The Log2 of the starting size</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkNomLongs(int)"> +<h3>checkNomLongs</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">checkNomLongs</span><wbr><span class="parameters">(int nomLongs)</span></div> +<div class="block">Checks that the given nomLongs is within bounds and returns the Log2 of the ceiling power of 2 + of the given nomLongs.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomLongs</code> - the given number of nominal longs. This can be any value from 16 to + 67108864, inclusive.</dd> +<dt>Returns:</dt> +<dd>The Log2 of the ceiling power of 2 of the given nomLongs.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BinomialBoundsN.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BinomialBoundsN.html new file mode 100644 index 000000000..ee169686c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BinomialBoundsN.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.thetacommon.BinomialBoundsN (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: BinomialBoundsN"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BinomialBoundsN.html" title="class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.thetacommon.BinomialBoundsN" class="title">Uses of Class<br>org.apache.datasketches.thetacommon.BinomialBoundsN</h1> +</div> +No usage of org.apache.datasketches.thetacommon.BinomialBoundsN</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BoundsOnRatiosInThetaSketchedSets.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BoundsOnRatiosInThetaSketchedSets.html new file mode 100644 index 000000000..40f2e4965 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BoundsOnRatiosInThetaSketchedSets.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.thetacommon.BoundsOnRatiosInThetaSketchedSets (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: BoundsOnRatiosInThetaSketchedSets"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.thetacommon.BoundsOnRatiosInThetaSketchedSets" class="title">Uses of Class<br>org.apache.datasketches.thetacommon.BoundsOnRatiosInThetaSketchedSets</h1> +</div> +No usage of org.apache.datasketches.thetacommon.BoundsOnRatiosInThetaSketchedSets</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BoundsOnRatiosInTupleSketchedSets.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BoundsOnRatiosInTupleSketchedSets.html new file mode 100644 index 000000000..87b38f3b2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/BoundsOnRatiosInTupleSketchedSets.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.thetacommon.BoundsOnRatiosInTupleSketchedSets (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: BoundsOnRatiosInTupleSketchedSets"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.thetacommon.BoundsOnRatiosInTupleSketchedSets" class="title">Uses of Class<br>org.apache.datasketches.thetacommon.BoundsOnRatiosInTupleSketchedSets</h1> +</div> +No usage of org.apache.datasketches.thetacommon.BoundsOnRatiosInTupleSketchedSets</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/HashOperations.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/HashOperations.html new file mode 100644 index 000000000..5006a317a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/HashOperations.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.thetacommon.HashOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: HashOperations"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../HashOperations.html" title="class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.thetacommon.HashOperations" class="title">Uses of Class<br>org.apache.datasketches.thetacommon.HashOperations</h1> +</div> +No usage of org.apache.datasketches.thetacommon.HashOperations</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/QuickSelect.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/QuickSelect.html new file mode 100644 index 000000000..0f2265a43 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/QuickSelect.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.thetacommon.QuickSelect (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: QuickSelect"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../QuickSelect.html" title="class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.thetacommon.QuickSelect" class="title">Uses of Class<br>org.apache.datasketches.thetacommon.QuickSelect</h1> +</div> +No usage of org.apache.datasketches.thetacommon.QuickSelect</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.AnotbAction.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.AnotbAction.html new file mode 100644 index 000000000..feb934838 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.AnotbAction.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.AnotbAction (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: AnotbAction"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.AnotbAction" class="title">Uses of Enum Class<br>org.apache.datasketches.thetacommon.SetOperationCornerCases.AnotbAction</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<h2>Uses of <a href="../SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a> in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a> that return <a href="../SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.CornerCase.</span><code><a href="../SetOperationCornerCases.CornerCase.html#getAnotbAction()" class="member-name-link">getAnotbAction</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the AnotB action</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationCornerCases.AnotbAction.</span><code><a href="../SetOperationCornerCases.AnotbAction.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.AnotbAction.</span><code><a href="../SetOperationCornerCases.AnotbAction.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.CornerCase.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.CornerCase.html new file mode 100644 index 000000000..50e1c5600 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.CornerCase.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.CornerCase (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: CornerCase"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.CornerCase" class="title">Uses of Enum Class<br>org.apache.datasketches.thetacommon.SetOperationCornerCases.CornerCase</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<h2>Uses of <a href="../SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a> in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a> that return <a href="../SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.CornerCase.</span><code><a href="../SetOperationCornerCases.CornerCase.html#caseIdToCornerCase(int)" class="member-name-link">caseIdToCornerCase</a><wbr>(int id)</code></div> +<div class="col-last even-row-color"> +<div class="block">Converts caseId to CornerCaseId</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationCornerCases.CornerCase.</span><code><a href="../SetOperationCornerCases.CornerCase.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.CornerCase.</span><code><a href="../SetOperationCornerCases.CornerCase.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.IntersectAction.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.IntersectAction.html new file mode 100644 index 000000000..f2b500f06 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.IntersectAction.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.IntersectAction (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: IntersectAction"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.IntersectAction" class="title">Uses of Enum Class<br>org.apache.datasketches.thetacommon.SetOperationCornerCases.IntersectAction</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<h2>Uses of <a href="../SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a> in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a> that return <a href="../SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.CornerCase.</span><code><a href="../SetOperationCornerCases.CornerCase.html#getIntersectAction()" class="member-name-link">getIntersectAction</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the intersect action</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationCornerCases.IntersectAction.</span><code><a href="../SetOperationCornerCases.IntersectAction.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.IntersectAction.</span><code><a href="../SetOperationCornerCases.IntersectAction.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.UnionAction.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.UnionAction.html new file mode 100644 index 000000000..bba14bfc9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.UnionAction.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.UnionAction (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases, enum: UnionAction"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.thetacommon.SetOperationCornerCases.UnionAction" class="title">Uses of Enum Class<br>org.apache.datasketches.thetacommon.SetOperationCornerCases.UnionAction</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<h2>Uses of <a href="../SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a> in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.thetacommon</a> that return <a href="../SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.CornerCase.</span><code><a href="../SetOperationCornerCases.CornerCase.html#getUnionAction()" class="member-name-link">getUnionAction</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the union action</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SetOperationCornerCases.UnionAction.</span><code><a href="../SetOperationCornerCases.UnionAction.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">SetOperationCornerCases.UnionAction.</span><code><a href="../SetOperationCornerCases.UnionAction.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.html new file mode 100644 index 000000000..47e5b82eb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/SetOperationCornerCases.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.thetacommon.SetOperationCornerCases (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: SetOperationCornerCases"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.thetacommon.SetOperationCornerCases" class="title">Uses of Class<br>org.apache.datasketches.thetacommon.SetOperationCornerCases</h1> +</div> +No usage of org.apache.datasketches.thetacommon.SetOperationCornerCases</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/ThetaUtil.html b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/ThetaUtil.html new file mode 100644 index 000000000..4b4b1a919 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/class-use/ThetaUtil.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.thetacommon.ThetaUtil (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon, class: ThetaUtil"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.thetacommon.ThetaUtil" class="title">Uses of Class<br>org.apache.datasketches.thetacommon.ThetaUtil</h1> +</div> +No usage of org.apache.datasketches.thetacommon.ThetaUtil</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/package-summary.html b/docs/7.0.X/org/apache/datasketches/thetacommon/package-summary.html new file mode 100644 index 000000000..cd16d1c9d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/package-summary.html @@ -0,0 +1,179 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.thetacommon (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.thetacommon"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.thetacommon" class="title">Package org.apache.datasketches.thetacommon</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.thetacommon</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BinomialBoundsN.html" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This class enables the estimation of error bounds given a sample set size, the sampling + probability theta, the number of standard deviations and a simple noDataSeen flag.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + + <i>A</i> is a Theta Sketch of population <i>PopA</i>. + <i>B</i> is a Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Theta Sketch <i>C</i>, + which acts like a predicate or selection clause. + The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). + The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). + The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). + + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: + + <i>A</i> is a Tuple Sketch of population <i>PopA</i>. + <i>B</i> is a Tuple or Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, + obtained by an intersection of <i>A</i> with some other Tuple or Theta Sketch <i>C</i>, + which acts like a predicate or selection clause. + The estimate of the ratio <i>PopB/PopA</i> is + BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). + The Upper Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). + The Lower Bound estimate on the ratio PopB/PopA is + BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). + + Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Helper class for the common hash table methods.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">QuickSelect algorithm improved from Sedgewick.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Simplifies and speeds up set operations by resolving specific corner cases.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="SetOperationCornerCases.AnotbAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">A not B actions</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="SetOperationCornerCases.CornerCase.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block">List of corner cases</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="SetOperationCornerCases.IntersectAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">Intersection actions</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="SetOperationCornerCases.UnionAction.html" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block">List of union actions</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Utility methods for the Theta Family of sketches</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/package-tree.html b/docs/7.0.X/org/apache/datasketches/thetacommon/package-tree.html new file mode 100644 index 000000000..477664371 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/package-tree.html @@ -0,0 +1,99 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.thetacommon Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.thetacommon"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.thetacommon</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.thetacommon.<a href="BinomialBoundsN.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="BoundsOnRatiosInThetaSketchedSets.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="BoundsOnRatiosInTupleSketchedSets.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="HashOperations.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">HashOperations</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="QuickSelect.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="SetOperationCornerCases.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="ThetaUtil.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.thetacommon.<a href="SetOperationCornerCases.AnotbAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="SetOperationCornerCases.CornerCase.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="SetOperationCornerCases.IntersectAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="SetOperationCornerCases.UnionAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/thetacommon/package-use.html b/docs/7.0.X/org/apache/datasketches/thetacommon/package-use.html new file mode 100644 index 000000000..ffbc445f9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/thetacommon/package-use.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.thetacommon (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.thetacommon"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.thetacommon" class="title">Uses of Package<br>org.apache.datasketches.thetacommon</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.thetacommon</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.thetacommon</a> used by <a href="package-summary.html">org.apache.datasketches.thetacommon</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/SetOperationCornerCases.AnotbAction.html#org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></div> +<div class="col-last even-row-color"> +<div class="block">A not B actions</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SetOperationCornerCases.CornerCase.html#org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></div> +<div class="col-last odd-row-color"> +<div class="block">List of corner cases</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SetOperationCornerCases.IntersectAction.html#org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></div> +<div class="col-last even-row-color"> +<div class="block">Intersection actions</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SetOperationCornerCases.UnionAction.html#org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></div> +<div class="col-last odd-row-color"> +<div class="block">List of union actions</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/AnotB.html b/docs/7.0.X/org/apache/datasketches/tuple/AnotB.html new file mode 100644 index 000000000..28eedddeb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/AnotB.html @@ -0,0 +1,397 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>AnotB (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: AnotB"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/AnotB.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class AnotB" class="title">Class AnotB<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.AnotB<S></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">AnotB<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches. + This class includes both stateful and stateless operations. + + <p>The stateful operation is as follows:</p> + <pre><code> + AnotB anotb = new AnotB(); + + anotb.setA(Sketch skA); //The first argument. + anotb.notB(Sketch skB); //The second (subtraction) argument. + anotb.notB(Sketch skC); // ...any number of additional subtractions... + anotb.getResult(false); //Get an interim result. + anotb.notB(Sketch skD); //Additional subtractions. + anotb.getResult(true); //Final result and resets the AnotB operator. + </code></pre> + + <p>The stateless operation is as follows:</p> + <pre><code> + AnotB anotb = new AnotB(); + + CompactSketch csk = anotb.aNotB(Sketch skA, Sketch skB); + </code></pre> + + <p>Calling the <i>setA</i> operation a second time essentially clears the internal state and loads + the new sketch.</p> + + <p>The stateless and stateful operations are independent of each other.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AnotB</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="AnotB.html" title="type parameter in AnotB">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult(boolean)" class="member-name-link">getResult</a><wbr>(boolean reset)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="#setA(org.apache.datasketches.tuple.Sketch)"><code>setA(Sketch)</code></a> and (<a href="#notB(org.apache.datasketches.tuple.Sketch)"><code>notB(Sketch)</code></a> or + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#notB(org.apache.datasketches.theta.Sketch)" class="member-name-link">notB</a><wbr>(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#notB(org.apache.datasketches.tuple.Sketch)" class="member-name-link">notB</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="AnotB.html" title="type parameter in AnotB">S</a>> skB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this operation back to the empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setA(org.apache.datasketches.tuple.Sketch)" class="member-name-link">setA</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="AnotB.html" title="type parameter in AnotB">S</a>> skA)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>AnotB</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AnotB</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setA(org.apache.datasketches.tuple.Sketch)"> +<h3>setA</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setA</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="AnotB.html" title="type parameter in AnotB">S</a>> skA)</span></div> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>. This overwrites the internal state of this + AnotB operator with the contents of the given sketch. + This sets the stage for multiple following <i>notB</i> steps. + + <p>An input argument of null will throw an exception.</p> + + <p>Rationale: In mathematics a "null set" is a set with no members, which we call an empty set. + That is distinctly different from the java <i>null</i>, which represents a nonexistent object. + In most cases it is a programming error due to some object that was not properly initialized. + With a null as the first argument, we cannot know what the user's intent is. + Since it is very likely that a <i>null</i> is a programming error, we throw a an exception.</p> + + <p>An empty input argument will set the internal state to empty.</p> + + <p>Rationale: An empty set is a mathematically legal concept. Although it makes any subsequent, + valid argument for B irrelevant, we must allow this and assume the user knows what they are + doing.</p> + + <p>Performing <a href="#getResult(boolean)"><code>getResult(boolean)</code></a> just after this step will return a compact form of + the given argument.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>skA</code> - The incoming sketch for the first argument, <i>A</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="notB(org.apache.datasketches.tuple.Sketch)"> +<h3>notB</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">notB</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="AnotB.html" title="type parameter in AnotB">S</a>> skB)</span></div> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>. + Performs an <i>AND NOT</i> operation with the existing internal state of this AnotB operator. + + <p>An input argument of null or empty is ignored.</p> + + <p>Rationale: A <i>null</i> for the second or following arguments is more tolerable because + <i>A NOT null</i> is still <i>A</i> even if we don't know exactly what the null represents. It + clearly does not have any content that overlaps with <i>A</i>. Also, because this can be part of + a multistep operation with multiple <i>notB</i> steps. Other following steps can still produce + a valid result.</p> + + <p>Use <a href="#getResult(boolean)"><code>getResult(boolean)</code></a> to obtain the result.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>skB</code> - The incoming Tuple sketch for the second (or following) argument <i>B</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="notB(org.apache.datasketches.theta.Sketch)"> +<h3>notB</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">notB</span><wbr><span class="parameters">(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</span></div> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>. + Performs an <i>AND NOT</i> operation with the existing internal state of this AnotB operator. + Calls to this method can be intermingled with calls to + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>. + + <p>An input argument of null or empty is ignored.</p> + + <p>Rationale: A <i>null</i> for the second or following arguments is more tolerable because + <i>A NOT null</i> is still <i>A</i> even if we don't know exactly what the null represents. It + clearly does not have any content that overlaps with <i>A</i>. Also, because this can be part of + a multistep operation with multiple <i>notB</i> steps. Other following steps can still produce + a valid result.</p> + + <p>Use <a href="#getResult(boolean)"><code>getResult(boolean)</code></a> to obtain the result.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>skB</code> - The incoming Theta sketch for the second (or following) argument <i>B</i>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(boolean)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="AnotB.html" title="type parameter in AnotB">S</a>></span> <span class="element-name">getResult</span><wbr><span class="parameters">(boolean reset)</span></div> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="#setA(org.apache.datasketches.tuple.Sketch)"><code>setA(Sketch)</code></a> and (<a href="#notB(org.apache.datasketches.tuple.Sketch)"><code>notB(Sketch)</code></a> or + <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>reset</code> - If <i>true</i>, clears this operator to the empty state after this result is + returned. Set this to <i>false</i> if you wish to obtain an intermediate result.</dd> +<dt>Returns:</dt> +<dd>the result of this operation as an unordered <a href="CompactSketch.html" title="class in org.apache.datasketches.tuple"><code>CompactSketch</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"> +<h3>aNotB</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></span> <span class="element-name">aNotB</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skB)</span></div> +<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches. + + <p>This a stateless operation and has no impact on the internal state of this operator. + Thus, this is not an accumulating update and is independent of the <a href="#setA(org.apache.datasketches.tuple.Sketch)"><code>setA(Sketch)</code></a>, + <a href="#notB(org.apache.datasketches.tuple.Sketch)"><code>notB(Sketch)</code></a>, <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>, and + <a href="#getResult(boolean)"><code>getResult(boolean)</code></a> methods.</p> + + <p>If either argument is null an exception is thrown.</p> + + <p>Rationale: In mathematics a "null set" is a set with no members, which we call an empty set. + That is distinctly different from the java <i>null</i>, which represents a nonexistent object. + In most cases it is a programming error due to some object that was not properly initialized. + With a null as the first argument, we cannot know what the user's intent is. + With a null as the second argument, we can't ignore it as we must return a result and there is + no following possible viable arguments for the second argument. + Since it is very likely that a <i>null</i> is a programming error, we throw an exception.</p></div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +<dt>Parameters:</dt> +<dd><code>skA</code> - The incoming Tuple sketch for the first argument</dd> +<dd><code>skB</code> - The incoming Tuple sketch for the second argument</dd> +<dt>Returns:</dt> +<dd>the result as an unordered <a href="CompactSketch.html" title="class in org.apache.datasketches.tuple"><code>CompactSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)"> +<h3>aNotB</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></span> <span class="element-name">aNotB</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</span></div> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch. + + <p>This a stateless operation and has no impact on the internal state of this operator. + Thus, this is not an accumulating update and is independent of the <a href="#setA(org.apache.datasketches.tuple.Sketch)"><code>setA(Sketch)</code></a>, + <a href="#notB(org.apache.datasketches.tuple.Sketch)"><code>notB(Sketch)</code></a>, <a href="#notB(org.apache.datasketches.theta.Sketch)"><code>notB(org.apache.datasketches.theta.Sketch)</code></a>, and + <a href="#getResult(boolean)"><code>getResult(boolean)</code></a> methods.</p> + + <p>If either argument is null an exception is thrown.</p> + + <p>Rationale: In mathematics a "null set" is a set with no members, which we call an empty set. + That is distinctly different from the java <i>null</i>, which represents a nonexistent object. + In most cases it is a programming error due to some object that was not properly initialized. + With a null as the first argument, we cannot know what the user's intent is. + With a null as the second argument, we can't ignore it as we must return a result and there is + no following possible viable arguments for the second argument. + Since it is very likely that a <i>null</i> is a programming error for either argument + we throw a an exception.</p></div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +<dt>Parameters:</dt> +<dd><code>skA</code> - The incoming Tuple sketch for the first argument</dd> +<dd><code>skB</code> - The incoming Theta sketch for the second argument</dd> +<dt>Returns:</dt> +<dd>the result as an unordered <a href="CompactSketch.html" title="class in org.apache.datasketches.tuple"><code>CompactSketch</code></a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this operation back to the empty state.</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/CompactSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/CompactSketch.html new file mode 100644 index 000000000..efe14b6b5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/CompactSketch.html @@ -0,0 +1,241 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CompactSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: CompactSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CompactSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class CompactSketch" class="title">Class CompactSketch<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S> +<div class="inheritance">org.apache.datasketches.tuple.CompactSketch<S></div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - type of Summary</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CompactSketch<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> +<span class="extends-implements">extends <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></span></div> +<div class="block">CompactSketches are never created directly. They are created as a result of + the compact() method of an UpdatableSketch or as a result of the getResult() + method of a set operation like Union, Intersection or AnotB. CompactSketch + consists of a compact list (i.e. no intervening spaces) of hash values, + corresponding list of Summaries, and a value for theta. The lists may or may + not be ordered. CompactSketch is read-only.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Converts this sketch to a CompactSketch on the Java heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SketchIterator</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to serialize a sketch instance to a byte array.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.Sketch">Methods inherited from class org.apache.datasketches.tuple.<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> +<code><a href="Sketch.html#getEstimate()">getEstimate</a>, <a href="Sketch.html#getEstimate(int)">getEstimate</a>, <a href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="Sketch.html#getLowerBound(int,int)">getLowerBound</a>, <a href="Sketch.html#getSummaryFactory()">getSummaryFactory</a>, <a href="Sketch.html#getTheta()">getTheta</a>, <a href="Sketch.html#getThetaLong()">getThetaLong</a>, <a href="Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="Sketch.html#getUpperBound(int,int)">getUpperBound</a>, <a href="Sketch.html#isEmpty()">isEmpty</a>, <a href="Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="Sketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a>></span> <span class="element-name">compact</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#compact()">Sketch</a></code></span></div> +<div class="block">Converts this sketch to a CompactSketch on the Java heap. + + <p>If this sketch is already in compact form this operation returns <i>this</i>.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#compact()">compact</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>this sketch as a CompactSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#getRetainedEntries()">getRetainedEntries</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#getCountLessThanThetaLong(long)">Sketch</a></code></span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#toByteArray()">Sketch</a></code></span></div> +<div class="block">This is to serialize a sketch instance to a byte array. + + <p>As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</p></div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#toByteArray()">toByteArray</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#iterator()">Sketch</a></code></span></div> +<div class="block">Returns a SketchIterator</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#iterator()">iterator</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>a SketchIterator</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/DeserializeResult.html b/docs/7.0.X/org/apache/datasketches/tuple/DeserializeResult.html new file mode 100644 index 000000000..1863c766e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/DeserializeResult.html @@ -0,0 +1,195 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DeserializeResult (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: DeserializeResult"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DeserializeResult.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class DeserializeResult" class="title">Class DeserializeResult<T></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.DeserializeResult<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - Type of object</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DeserializeResult<T></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(T,int)" class="member-name-link">DeserializeResult</a><wbr>(<a href="DeserializeResult.html" title="type parameter in DeserializeResult">T</a> object, + int size)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DeserializeResult.html" title="type parameter in DeserializeResult">T</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObject()" class="member-name-link">getObject</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSize()" class="member-name-link">getSize</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(T,int)"> +<h3 id="<init>(java.lang.Object,int)">DeserializeResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DeserializeResult</span><wbr><span class="parameters">(<a href="DeserializeResult.html" title="type parameter in DeserializeResult">T</a> object, + int size)</span></div> +<div class="block">Creates an instance.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>object</code> - Deserialized object.</dd> +<dd><code>size</code> - Deserialized size in bytes.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getObject()"> +<h3>getObject</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DeserializeResult.html" title="type parameter in DeserializeResult">T</a></span> <span class="element-name">getObject</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Deserialized object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSize()"> +<h3>getSize</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSize</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Size in bytes occupied by the object in the serialized form</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/Filter.html b/docs/7.0.X/org/apache/datasketches/tuple/Filter.html new file mode 100644 index 000000000..9c4b1aa42 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/Filter.html @@ -0,0 +1,186 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Filter (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: Filter"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Filter.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class Filter" class="title">Class Filter<T extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.Filter<T></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>T</code> - Summary type against which apply the <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link"><code>Predicate</code></a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Filter<T extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Class for filtering entries from a <a href="Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.function.Predicate)" class="member-name-link">Filter</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="Filter.html" title="type parameter in Filter">T</a>> predicate)</code></div> +<div class="col-last even-row-color"> +<div class="block">Filter constructor with a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link"><code>Predicate</code></a></div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Filter.html" title="type parameter in Filter">T</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#filter(org.apache.datasketches.tuple.Sketch)" class="member-name-link">filter</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Filter.html" title="type parameter in Filter">T</a>> sketchIn)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Filters elements on the provided <a href="Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a></div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(java.util.function.Predicate)"> +<h3>Filter</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Filter</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="Filter.html" title="type parameter in Filter">T</a>> predicate)</span></div> +<div class="block">Filter constructor with a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link"><code>Predicate</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>predicate</code> - Predicate to use in this filter. If the Predicate returns False, the + element is discarded. If the Predicate returns True, then the element is kept in the + <a href="Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="filter(org.apache.datasketches.tuple.Sketch)"> +<h3>filter</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Filter.html" title="type parameter in Filter">T</a>></span> <span class="element-name">filter</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Filter.html" title="type parameter in Filter">T</a>> sketchIn)</span></div> +<div class="block">Filters elements on the provided <a href="Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchIn</code> - The sketch against which apply the <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link"><code>Predicate</code></a></dd> +<dt>Returns:</dt> +<dd>A new Sketch with some of the entries filtered out based on the <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link"><code>Predicate</code></a></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/Intersection.html b/docs/7.0.X/org/apache/datasketches/tuple/Intersection.html new file mode 100644 index 000000000..bc3bada4b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/Intersection.html @@ -0,0 +1,307 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Intersection (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: Intersection"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Intersection.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class Intersection" class="title">Class Intersection<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.Intersection<S></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Intersection<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches + combined with theta sketches. + A new instance represents the Universal Set. Because the Universal Set + cannot be realized a <i>getResult()</i> on a new instance will produce an error. + Every update() computes an intersection with the internal state, which will never + grow larger and may be reduced to zero.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Intersection</a><wbr>(<a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates new Intersection instance with instructions on how to process two summaries that + intersect.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the internal set as an unordered CompactSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasResult()" class="member-name-link">hasResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if there is a valid intersection result available</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersect(org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect</a><wbr>(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Intersection.html" title="type parameter in Intersection">S</a> summary)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Performs a stateful intersection of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary and rules + from the summarySetOps defined by the Intersection constructor.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersect(org.apache.datasketches.tuple.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Intersection.html" title="type parameter in Intersection">S</a> summary)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the + result as an unordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchB)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Perform a stateless intersect set operation on the two given tuple sketches and returns the + result as an unordered CompactSketch on the heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets the internal set to the initial state, which represents the Universal Set</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.SummarySetOperations)"> +<h3>Intersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Intersection</span><wbr><span class="parameters">(<a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> summarySetOps)</span></div> +<div class="block">Creates new Intersection instance with instructions on how to process two summaries that + intersect.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summarySetOps</code> - instance of SummarySetOperations</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"> +<h3>intersect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>></span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchB)</span></div> +<div class="block">Perform a stateless intersect set operation on the two given tuple sketches and returns the + result as an unordered CompactSketch on the heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketchA</code> - The first sketch argument. It must not be null.</dd> +<dd><code>tupleSketchB</code> - The second sketch argument. It must not be null.</dd> +<dt>Returns:</dt> +<dd>an unordered CompactSketch on the heap</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)"> +<h3 id="intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary)">intersect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>></span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Intersection.html" title="type parameter in Intersection">S</a> summary)</span></div> +<div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the + result as an unordered CompactSketch on the heap.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketch</code> - The first sketch argument. It must not be null.</dd> +<dd><code>thetaSketch</code> - The second sketch argument. It must not be null.</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. + This must not be null.</dd> +<dt>Returns:</dt> +<dd>an unordered CompactSketch on the heap</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersect(org.apache.datasketches.tuple.Sketch)"> +<h3>intersect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch)</span></div> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketch</code> - input sketch to intersect with the internal state. It must not be null.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersect(org.apache.datasketches.theta.Sketch,S)"> +<h3 id="intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary)">intersect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Intersection.html" title="type parameter in Intersection">S</a> summary)</span></div> +<div class="block">Performs a stateful intersection of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary and rules + from the summarySetOps defined by the Intersection constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>thetaSketch</code> - input theta sketch to intersect with the internal state. It must not be null.</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. + It will be copied for each matching index. It must not be null.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Intersection.html" title="type parameter in Intersection">S</a>></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the internal set as an unordered CompactSketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>result of the intersections so far</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasResult()"> +<h3>hasResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasResult</span>()</div> +<div class="block">Returns true if there is a valid intersection result available</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if there is a valid intersection result available</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets the internal set to the initial state, which represents the Universal Set</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/JaccardSimilarity.html b/docs/7.0.X/org/apache/datasketches/tuple/JaccardSimilarity.html new file mode 100644 index 000000000..851be5e8f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/JaccardSimilarity.html @@ -0,0 +1,440 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>JaccardSimilarity (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: JaccardSimilarity"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/JaccardSimilarity.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class JaccardSimilarity" class="title">Class JaccardSimilarity</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.JaccardSimilarity</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">JaccardSimilarity</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Jaccard similarity of two Tuple Sketches, or alternatively, of a Tuple and Theta Sketch. + + <p>Note: only retained hash values are compared, and the Tuple summary values are not accounted for in the + similarity measure.</p></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes, David Cromberge</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JaccardSimilarity</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>JaccardSimilarity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JaccardSimilarity</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)"> +<h3>jaccard</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double[]</span> <span class="element-name">jaccard</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</span></div> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds. The Jaccard similarity index + <i>J(A,B) = (A ^ B)/(A U B)</i> is used to measure how similar the two sketches are to each + other. If J = 1.0, the sketches are considered equal. If J = 0, the two sketches are + distinct from each other. A Jaccard of .95 means the overlap between the two + populations is 95% of the union of the two populations. + + <p>Note: For very large pairs of sketches, where the configured nominal entries of the sketches + are 2^25 or 2^26, this method may produce unpredictable results.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> +<dd><code>sketchB</code> - The second argument, a Tuple sketch with summary type <i>S</i></dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dt>Returns:</dt> +<dd>a double array {LowerBound, Estimate, UpperBound} of the Jaccard index. + The Upper and Lower bounds are for a confidence interval of 95.4% or +/- 2 standard deviations.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)"> +<h3 id="jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary,org.apache.datasketches.tuple.SummarySetOperations)">jaccard</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">double[]</span> <span class="element-name">jaccard</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</span></div> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds. The Jaccard similarity index + <i>J(A,B) = (A ^ B)/(A U B)</i> is used to measure how similar the two sketches are to each + other. If J = 1.0, the sketches are considered equal. If J = 0, the two sketches are + distinct from each other. A Jaccard of .95 means the overlap between the two + populations is 95% of the union of the two populations. + + <p>Note: For very large pairs of sketches, where the configured nominal entries of the sketches + are 2^25 or 2^26, this method may produce unpredictable results.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> +<dd><code>sketchB</code> - The second argument, a Theta sketch</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. + This may not be null.</dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dt>Returns:</dt> +<dd>a double array {LowerBound, Estimate, UpperBound} of the Jaccard index. + The Upper and Lower bounds are for a confidence interval of 95.4% or +/- 2 standard deviations.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)"> +<h3>exactlyEqual</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">boolean</span> <span class="element-name">exactlyEqual</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</span></div> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values. Thus, they are equivalent.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> +<dd><code>sketchB</code> - The second argument, a Tuple sketch with summary type <i>S</i></dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dt>Returns:</dt> +<dd>true if the two given sketches have exactly the same hash values and the same + theta values.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)"> +<h3 id="exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary,org.apache.datasketches.tuple.SummarySetOperations)">exactlyEqual</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">boolean</span> <span class="element-name">exactlyEqual</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</span></div> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values. Thus, they are equivalent.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> +<dd><code>sketchB</code> - The second argument, a Theta sketch</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. + This may not be null.</dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dt>Returns:</dt> +<dd>true if the two given sketches have exactly the same hash values and the same + theta values.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)"> +<h3>similarityTest</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">boolean</span> <span class="element-name">similarityTest</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</span></div> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch. + Computes the lower bound of the Jaccard index <i>J<sub>LB</sub></i> of the measured and + expected sketches. + if <i>J<sub>LB</sub> ≥ threshold</i>, then the sketches are considered to be + similar with a confidence of 97.7%.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> +<dd><code>expected</code> - the reference Tuple sketch with summary type <i>S</i> that is considered to be correct.</dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dd><code>threshold</code> - a real value between zero and one.</dd> +<dt>Returns:</dt> +<dd>if true, the similarity of the two sketches is greater than the given threshold + with at least 97.7% confidence.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)"> +<h3 id="similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary,org.apache.datasketches.tuple.SummarySetOperations,double)">similarityTest</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">boolean</span> <span class="element-name">similarityTest</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</span></div> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch. + Computes the lower bound of the Jaccard index <i>J<sub>LB</sub></i> of the measured and + expected sketches. + if <i>J<sub>LB</sub> ≥ threshold</i>, then the sketches are considered to be + similar with a confidence of 97.7%.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> +<dd><code>expected</code> - the reference Theta sketch that is considered to be correct.</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. + This may not be null.</dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dd><code>threshold</code> - a real value between zero and one.</dd> +<dt>Returns:</dt> +<dd>if true, the similarity of the two sketches is greater than the given threshold + with at least 97.7% confidence.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)"> +<h3>dissimilarityTest</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">boolean</span> <span class="element-name">dissimilarityTest</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</span></div> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch. + Computes the upper bound of the Jaccard index <i>J<sub>UB</sub></i> of the measured and + expected sketches. + if <i>J<sub>UB</sub> ≤ threshold</i>, then the sketches are considered to be + dissimilar with a confidence of 97.7%.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> +<dd><code>expected</code> - the reference Theta sketch that is considered to be correct.</dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dd><code>threshold</code> - a real value between zero and one.</dd> +<dt>Returns:</dt> +<dd>if true, the dissimilarity of the two sketches is greater than the given threshold + with at least 97.7% confidence.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)"> +<h3 id="dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary,org.apache.datasketches.tuple.SummarySetOperations,double)">dissimilarityTest</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">boolean</span> <span class="element-name">dissimilarityTest</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</span></div> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch. + Computes the upper bound of the Jaccard index <i>J<sub>UB</sub></i> of the measured and + expected sketches. + if <i>J<sub>UB</sub> ≤ threshold</i>, then the sketches are considered to be + dissimilar with a confidence of 97.7%.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Summary</dd> +<dt>Parameters:</dt> +<dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> +<dd><code>expected</code> - the reference Theta sketch that is considered to be correct.</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. + This may not be null.</dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> +<dd><code>threshold</code> - a real value between zero and one.</dd> +<dt>Returns:</dt> +<dd>if true, the dissimilarity of the two sketches is greater than the given threshold + with at least 97.7% confidence.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html b/docs/7.0.X/org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html new file mode 100644 index 000000000..e27b7554c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html @@ -0,0 +1,266 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SerializerDeserializer.SketchType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: SerializerDeserializer, enum: SketchType"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SerializerDeserializer.SketchType.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Enum Class SerializerDeserializer.SketchType" class="title">Enum Class SerializerDeserializer.SketchType</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a>> +<div class="inheritance">org.apache.datasketches.tuple.SerializerDeserializer.SketchType</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">SerializerDeserializer.SketchType</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a>></span></div> +<div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#ArrayOfDoublesCompactSketch" class="member-name-link">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">ArrayOfDoublesCompactSketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="#ArrayOfDoublesQuickSelectSketch" class="member-name-link">ArrayOfDoublesQuickSelectSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">ArrayOfDoublesQuickSelectSketch</div> +</div> +<div class="col-first even-row-color"><code><a href="#ArrayOfDoublesUnion" class="member-name-link">ArrayOfDoublesUnion</a></code></div> +<div class="col-last even-row-color"> +<div class="block">ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color"><code><a href="#CompactSketch" class="member-name-link">CompactSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">CompactSketch</div> +</div> +<div class="col-first even-row-color"><code><a href="#QuickSelectSketch" class="member-name-link">QuickSelectSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">QuickSelectSketch</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="QuickSelectSketch"> +<h3>QuickSelectSketch</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span> <span class="element-name">QuickSelectSketch</span></div> +<div class="block">QuickSelectSketch</div> +</section> +</li> +<li> +<section class="detail" id="CompactSketch"> +<h3>CompactSketch</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span> <span class="element-name">CompactSketch</span></div> +<div class="block">CompactSketch</div> +</section> +</li> +<li> +<section class="detail" id="ArrayOfDoublesQuickSelectSketch"> +<h3>ArrayOfDoublesQuickSelectSketch</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span> <span class="element-name">ArrayOfDoublesQuickSelectSketch</span></div> +<div class="block">ArrayOfDoublesQuickSelectSketch</div> +</section> +</li> +<li> +<section class="detail" id="ArrayOfDoublesCompactSketch"> +<h3>ArrayOfDoublesCompactSketch</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span> <span class="element-name">ArrayOfDoublesCompactSketch</span></div> +<div class="block">ArrayOfDoublesCompactSketch</div> +</section> +</li> +<li> +<section class="detail" id="ArrayOfDoublesUnion"> +<h3>ArrayOfDoublesUnion</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span> <span class="element-name">ArrayOfDoublesUnion</span></div> +<div class="block">ArrayOfDoublesUnion</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/SerializerDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/SerializerDeserializer.html new file mode 100644 index 000000000..edd7bbfbe --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/SerializerDeserializer.html @@ -0,0 +1,228 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SerializerDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: SerializerDeserializer"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SerializerDeserializer.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class SerializerDeserializer" class="title">Class SerializerDeserializer</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.SerializerDeserializer</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">SerializerDeserializer</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Multipurpose serializer-deserializer for a collection of sketches defined by the enum.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="SerializerDeserializer.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SerializerDeserializer</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSketchType(org.apache.datasketches.memory.Memory)" class="member-name-link">getSketchType</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the sketch type byte from the given Memory image</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validateFamily(byte,byte)" class="member-name-link">validateFamily</a><wbr>(byte familyId, + byte preambleLongs)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Validates the preamble-Longs value given the family ID</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validateType(byte,org.apache.datasketches.tuple.SerializerDeserializer.SketchType)" class="member-name-link">validateType</a><wbr>(byte sketchTypeByte, + <a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a> expectedType)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Validates the sketch type byte versus the expected value</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>SerializerDeserializer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SerializerDeserializer</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="validateFamily(byte,byte)"> +<h3>validateFamily</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">validateFamily</span><wbr><span class="parameters">(byte familyId, + byte preambleLongs)</span></div> +<div class="block">Validates the preamble-Longs value given the family ID</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>familyId</code> - the given family ID</dd> +<dd><code>preambleLongs</code> - the given preambleLongs value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="validateType(byte,org.apache.datasketches.tuple.SerializerDeserializer.SketchType)"> +<h3>validateType</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">validateType</span><wbr><span class="parameters">(byte sketchTypeByte, + <a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a> expectedType)</span></div> +<div class="block">Validates the sketch type byte versus the expected value</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketchTypeByte</code> - the given sketch type byte</dd> +<dd><code>expectedType</code> - the expected value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSketchType(org.apache.datasketches.memory.Memory)"> +<h3>getSketchType</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span> <span class="element-name">getSketchType</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Gets the sketch type byte from the given Memory image</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory image</dd> +<dt>Returns:</dt> +<dd>the SketchType</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/Sketch.html b/docs/7.0.X/org/apache/datasketches/tuple/Sketch.html new file mode 100644 index 000000000..e62e41935 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/Sketch.html @@ -0,0 +1,440 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Sketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: Sketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Sketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class Sketch" class="title">Class Sketch<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.Sketch<S></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></code>, <code><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Sketch<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Sketch.html" title="type parameter in Sketch">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Converts this sketch to a CompactSketch on the Java heap.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate(int)" class="member-name-link">getEstimate</a><wbr>(int numSubsetEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the estimate of the true distinct population of subset tuples represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int)" class="member-name-link">getLowerBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int,int)" class="member-name-link">getLowerBound</a><wbr>(int numStdDev, + int numSubsetEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the estimate of the lower bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="Sketch.html" title="type parameter in Sketch">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSummaryFactory()" class="member-name-link">getSummaryFactory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the Summary Factory class of type S</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTheta()" class="member-name-link">getTheta</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the value of theta as a double between zero and one</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThetaLong()" class="member-name-link">getThetaLong</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns Theta as a long</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int)" class="member-name-link">getUpperBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int,int)" class="member-name-link">getUpperBound</a><wbr>(int numStdDev, + int numSubsetEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the estimate of the upper bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="Sketch.html" title="type parameter in Sketch">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns a SketchIterator</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is to serialize a sketch instance to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Sketch.html" title="type parameter in Sketch">S</a>></span> <span class="element-name">compact</span>()</div> +<div class="block">Converts this sketch to a CompactSketch on the Java heap. + + <p>If this sketch is already in compact form this operation returns <i>this</i>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch as a CompactSketch on the Java heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>best estimate of the number of unique values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the upper bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the lower bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate(int)"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span><wbr><span class="parameters">(int numSubsetEntries)</span></div> +<div class="block">Gets the estimate of the true distinct population of subset tuples represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numSubsetEntries</code> - number of entries for a chosen subset of the sketch.</dd> +<dt>Returns:</dt> +<dd>the estimate of the true distinct population of subset tuples represented by the count + of entries in a subset of the total retained entries of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int,int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int numStdDev, + int numSubsetEntries)</span></div> +<div class="block">Gets the estimate of the lower bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dd><code>numSubsetEntries</code> - number of entries for a chosen subset of the sketch.</dd> +<dt>Returns:</dt> +<dd>the estimate of the lower bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int,int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int numStdDev, + int numSubsetEntries)</span></div> +<div class="block">Gets the estimate of the upper bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dd><code>numSubsetEntries</code> - number of entries for a chosen subset of the sketch.</dd> +<dt>Returns:</dt> +<dd>the estimate of the upper bound of the true distinct population represented by the count + of entries in a subset of the total retained entries of the sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode). + This is true if theta < 1.0 AND isEmpty() is false.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSummaryFactory()"> +<h3>getSummaryFactory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="Sketch.html" title="type parameter in Sketch">S</a>></span> <span class="element-name">getSummaryFactory</span>()</div> +<div class="block">Gets the Summary Factory class of type S</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the Summary Factory class of type S</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getTheta()"> +<h3>getTheta</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getTheta</span>()</div> +<div class="block">Gets the value of theta as a double between zero and one</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the value of theta as a double</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">This is to serialize a sketch instance to a byte array. + + <p>As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</p></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>serialized representation of the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="Sketch.html" title="type parameter in Sketch">S</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block">Returns a SketchIterator</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a SketchIterator</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getThetaLong()"> +<h3>getThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getThetaLong</span>()</div> +<div class="block">Returns Theta as a long</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Theta as a long</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/Sketches.html b/docs/7.0.X/org/apache/datasketches/tuple/Sketches.html new file mode 100644 index 000000000..d6400b934 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/Sketches.html @@ -0,0 +1,223 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Sketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: Sketches"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Sketches.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class Sketches" class="title">Class Sketches</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.Sketches</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Sketches</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Convenient static methods to instantiate generic tuple sketches.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Sketches</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createEmptySketch()" class="member-name-link">createEmptySketch</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifySketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Instantiate a Sketch from a given Memory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <U,<wbr> +S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>><br><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer, + <a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S> summaryFactory)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Instantiate UpdatableSketch from a given Memory</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>Sketches</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Sketches</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="createEmptySketch()"> +<h3>createEmptySketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></span> <span class="element-name">createEmptySketch</span>()</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +<dt>Returns:</dt> +<dd>an empty instance of Sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifySketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer)"> +<h3>heapifySketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type"><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></span> <span class="element-name">heapifySketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + <a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer)</span></div> +<div class="block">Instantiate a Sketch from a given Memory.</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object representing a Sketch</dd> +<dd><code>deserializer</code> - instance of SummaryDeserializer</dd> +<dt>Returns:</dt> +<dd>Sketch created from its Memory representation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)"> +<h3>heapifyUpdatableSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><U,<wbr> +S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></span> +<span class="return-type"><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S></span> <span class="element-name">heapifyUpdatableSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + <a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer, + <a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S> summaryFactory)</span></div> +<div class="block">Instantiate UpdatableSketch from a given Memory</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>U</code> - Type of update value</dd> +<dd><code>S</code> - Type of Summary</dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object representing a Sketch</dd> +<dd><code>deserializer</code> - instance of SummaryDeserializer</dd> +<dd><code>summaryFactory</code> - instance of SummaryFactory</dd> +<dt>Returns:</dt> +<dd>Sketch created from its Memory representation</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/Summary.html b/docs/7.0.X/org/apache/datasketches/tuple/Summary.html new file mode 100644 index 000000000..b164968e4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/Summary.html @@ -0,0 +1,166 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Summary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, interface: Summary"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Summary.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Interface Summary" class="title">Interface Summary</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Subinterfaces:</dt> +<dd><code><a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code>, <code><a href="adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code>, <code><a href="aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Summary</span></div> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Deep copy.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is to serialize a Summary instance to a byte array.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="return-type"><a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span> <span class="element-name">copy</span>()</div> +<div class="block">Deep copy. + + <p><b>Caution:</b> This must implement a deep copy.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>deep copy of the Summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block">This is to serialize a Summary instance to a byte array. + + <p>The user should encode in the byte array its total size, which is used during + deserialization, especially if the Summary has variable sized elements.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>serialized representation of the Summary</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/SummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/SummaryDeserializer.html new file mode 100644 index 000000000..c1b9b5d0d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/SummaryDeserializer.html @@ -0,0 +1,152 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, interface: SummaryDeserializer"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SummaryDeserializer.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Interface SummaryDeserializer" class="title">Interface SummaryDeserializer<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - type of Summary</dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="strings/ArrayOfStringsSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a></code>, <code><a href="adouble/DoubleSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a></code>, <code><a href="aninteger/IntegerSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SummaryDeserializer<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span></div> +<div class="block">Interface for deserializing user-defined Summary</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="SummaryDeserializer.html" title="type parameter in SummaryDeserializer">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is to create an instance of a Summary given a serialized representation.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapifySummary(org.apache.datasketches.memory.Memory)"> +<h3>heapifySummary</h3> +<div class="member-signature"><span class="return-type"><a href="DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="SummaryDeserializer.html" title="type parameter in SummaryDeserializer">S</a>></span> <span class="element-name">heapifySummary</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">This is to create an instance of a Summary given a serialized representation. + The user may assume that the start of the given Memory is the correct place to start + deserializing. However, the user must be able to determine the number of bytes required to + deserialize the summary as the capacity of the given Memory may + include multiple such summaries and may be much larger than required for a single summary.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object with serialized representation of a Summary</dd> +<dt>Returns:</dt> +<dd>DeserializedResult object, which contains a Summary object and number of bytes read + from the Memory</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/SummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/SummaryFactory.html new file mode 100644 index 000000000..a68ff5e08 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/SummaryFactory.html @@ -0,0 +1,142 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, interface: SummaryFactory"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SummaryFactory.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Interface SummaryFactory" class="title">Interface SummaryFactory<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - type of Summary</dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="strings/ArrayOfStringsSummaryFactory.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a></code>, <code><a href="adouble/DoubleSummaryFactory.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a></code>, <code><a href="aninteger/IntegerSummaryFactory.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SummaryFactory<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span></div> +<div class="block">Interface for user-defined SummaryFactory</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SummaryFactory.html" title="type parameter in SummaryFactory">S</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newSummary()" class="member-name-link">newSummary</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newSummary()"> +<h3>newSummary</h3> +<div class="member-signature"><span class="return-type"><a href="SummaryFactory.html" title="type parameter in SummaryFactory">S</a></span> <span class="element-name">newSummary</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>new instance of Summary</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/SummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/SummarySetOperations.html new file mode 100644 index 000000000..d5c493910 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/SummarySetOperations.html @@ -0,0 +1,181 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>SummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, interface: SummarySetOperations"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/SummarySetOperations.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Interface SummarySetOperations" class="title">Interface SummarySetOperations<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - type of Summary</dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="strings/ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></code>, <code><a href="adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></code>, <code><a href="aninteger/IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SummarySetOperations<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span></div> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#intersection(S,S)" class="member-name-link">intersection</a><wbr>(<a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> a, + <a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> b)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is called by the intersection operator when both sketches have the same hash value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#union(S,S)" class="member-name-link">union</a><wbr>(<a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> a, + <a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> b)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is called by the union operator when both sketches have the same hash value.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="union(S,S)"> +<h3 id="union(org.apache.datasketches.tuple.Summary,org.apache.datasketches.tuple.Summary)">union</h3> +<div class="member-signature"><span class="return-type"><a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> a, + <a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> b)</span></div> +<div class="block">This is called by the union operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>union of Summary A and Summary B</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersection(S,S)"> +<h3 id="intersection(org.apache.datasketches.tuple.Summary,org.apache.datasketches.tuple.Summary)">intersection</h3> +<div class="member-signature"><span class="return-type"><a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a></span> <span class="element-name">intersection</span><wbr><span class="parameters">(<a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> a, + <a href="SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> b)</span></div> +<div class="block">This is called by the intersection operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>intersection of Summary A and Summary B</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/TupleSketchIterator.html b/docs/7.0.X/org/apache/datasketches/tuple/TupleSketchIterator.html new file mode 100644 index 000000000..43e033d6c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/TupleSketchIterator.html @@ -0,0 +1,189 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>TupleSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: TupleSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/TupleSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class TupleSketchIterator" class="title">Class TupleSketchIterator<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.TupleSketchIterator<S></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TupleSketchIterator<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Iterator over a generic tuple sketch</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHash()" class="member-name-link">getHash</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the hash from the current entry in the sketch, which is a hash + of the original key passed to update().</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TupleSketchIterator.html" title="type parameter in TupleSketchIterator">S</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSummary()" class="member-name-link">getSummary</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets a Summary object from the current entry in the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Advancing the iterator and checking existence of the next entry + is combined here for efficiency.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block">Advancing the iterator and checking existence of the next entry + is combined here for efficiency. This results in an undefined + state of the iterator before the first call of this method.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the next element exists</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getHash()"> +<h3>getHash</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getHash</span>()</div> +<div class="block">Gets the hash from the current entry in the sketch, which is a hash + of the original key passed to update(). The original keys are not + retained. Don't call this before calling next() for the first time + or after getting false from next().</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>hash from the current entry</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSummary()"> +<h3>getSummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TupleSketchIterator.html" title="type parameter in TupleSketchIterator">S</a></span> <span class="element-name">getSummary</span>()</div> +<div class="block">Gets a Summary object from the current entry in the sketch. + Don't call this before calling next() for the first time + or after getting false from next().</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Summary object for the current entry (this is not a copy!)</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/Union.html b/docs/7.0.X/org/apache/datasketches/tuple/Union.html new file mode 100644 index 000000000..4a11f5ffc --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/Union.html @@ -0,0 +1,328 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Union (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: Union"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Union.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class Union" class="title">Class Union<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.Union<S></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - Type of Summary</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Union<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with + theta sketches. A new instance represents an empty set.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Union</a><wbr>(int nomEntries, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="Union.html" title="type parameter in Union">S</a>> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates new Union instance.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Union</a><wbr>(<a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="Union.html" title="type parameter in Union">S</a>> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates new Union instance with instructions on how to process two summaries that + overlap.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult(boolean)" class="member-name-link">getResult</a><wbr>(boolean reset)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets the internal set to the initial state, which represents an empty set.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union</a><wbr>(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Union.html" title="type parameter in Union">S</a> summary)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Performs a stateful union of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.Sketch)" class="member-name-link">union</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketch)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Performs a stateful union of the internal set with the given tupleSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketch, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Union.html" title="type parameter in Union">S</a> summary)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">union</a><wbr>(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketchB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Perform a stateless, pair-wise union operation between two tuple sketches.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.SummarySetOperations)"> +<h3>Union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Union</span><wbr><span class="parameters">(<a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="Union.html" title="type parameter in Union">S</a>> summarySetOps)</span></div> +<div class="block">Creates new Union instance with instructions on how to process two summaries that + overlap. This will have the default nominal entries (K).</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summarySetOps</code> - instance of SummarySetOperations</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,org.apache.datasketches.tuple.SummarySetOperations)"> +<h3>Union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Union</span><wbr><span class="parameters">(int nomEntries, + <a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="Union.html" title="type parameter in Union">S</a>> summarySetOps)</span></div> +<div class="block">Creates new Union instance.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - nominal entries (K). Forced to the nearest power of 2 greater than + given value.</dd> +<dd><code>summarySetOps</code> - instance of SummarySetOperations</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketchA, + <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketchB)</span></div> +<div class="block">Perform a stateless, pair-wise union operation between two tuple sketches. + The returned sketch will be cut back to the smaller of the two k values if required. + + <p>Nulls and empty sketches are ignored.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketchA</code> - The first argument</dd> +<dd><code>tupleSketchB</code> - The second argument</dd> +<dt>Returns:</dt> +<dd>the result ordered CompactSketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)"> +<h3 id="union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary)">union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketch, + <a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Union.html" title="type parameter in Union">S</a> summary)</span></div> +<div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch. + The returned sketch will be cut back to the smaller of the two k values if required. + + <p>Nulls and empty sketches are ignored.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketch</code> - The first argument</dd> +<dd><code>thetaSketch</code> - The second argument</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. + This may not be null.</dd> +<dt>Returns:</dt> +<dd>the result ordered CompactSketch on the heap.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.tuple.Sketch)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="Union.html" title="type parameter in Union">S</a>> tupleSketch)</span></div> +<div class="block">Performs a stateful union of the internal set with the given tupleSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketch</code> - input tuple sketch to merge with the internal set. + Nulls and empty sketches are ignored.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.theta.Sketch,S)"> +<h3 id="union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.tuple.Summary)">union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="Union.html" title="type parameter in Union">S</a> summary)</span></div> +<div class="block">Performs a stateful union of the internal set with the given thetaSketch by combining entries + using the hashes from the theta sketch and summary values from the given summary.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>thetaSketch</code> - the given theta sketch input. If null or empty, it is ignored.</dd> +<dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. This may + not be null.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>result of the stateful unions so far. The state of this operation is not reset after the + result is returned.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(boolean)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="Union.html" title="type parameter in Union">S</a>></span> <span class="element-name">getResult</span><wbr><span class="parameters">(boolean reset)</span></div> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>reset</code> - If <i>true</i>, clears this operator to the empty state after this result is + returned. Set this to <i>false</i> if you wish to obtain an intermediate result.</dd> +<dt>Returns:</dt> +<dd>result of the stateful union</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets the internal set to the initial state, which represents an empty set. This is only useful + after sequences of stateful union operations.</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSketch.html new file mode 100644 index 000000000..d8440f203 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSketch.html @@ -0,0 +1,602 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UpdatableSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: UpdatableSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UpdatableSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class UpdatableSketch" class="title">Class UpdatableSketch<U,<wbr>S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S> +<div class="inheritance">org.apache.datasketches.tuple.UpdatableSketch<U,<wbr>S></div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>U</code> - Type of the value, which is passed to update method of a Summary</dd> +<dd><code>S</code> - Type of the UpdatableSummary<U></dd> +</dl> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></code>, <code><a href="adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></code>, <code><a href="aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">UpdatableSketch<U,<wbr>S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></span> +<span class="extends-implements">extends <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></span></div> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys. + Summary objects are created using a user-defined SummaryFactory class, + which should allow very flexible parameterization if needed. + Keys are presented to a sketch along with values of a user-defined + update type U. When an entry is inserted into a sketch or a duplicate key is + presented to a sketch then summary.update(U value) method will be called. So + any kind of user-defined accumulation is possible. Summaries also must know + how to copy themselves. Also union and intersection of summaries can be + implemented in a sub-class of SummarySetOperations, which will be used in + case Union or Intersection of two instances of Tuple Sketch is needed</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketch</a><wbr>(int nomEntries, + int lgResizeFactor, + float samplingProbability, + <a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to create a new instance of an UpdatableQuickSelectSketch.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> deserializer, + <a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> summaryFactory)</code></div> +<div class="col-last odd-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.UpdatableSketch)" class="member-name-link">UpdatableSketch</a><wbr>(<a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Copy Constructor</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentCapacity()" class="member-name-link">getCurrentCapacity</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get current capacity</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get log_base2 of Nominal Entries</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNominalEntries()" class="member-name-link">getNominalEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured nominal number of entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured resize factor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplingProbability()" class="member-name-link">getSamplingProbability</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured sampling probability</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SketchIterator</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch an empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trim()" class="member-name-link">trim</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D,U)" class="member-name-link">update</a><wbr>(byte[] key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a byte[] key and U value.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double,U)" class="member-name-link">update</a><wbr>(double key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a double key and U value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(int%5B%5D,U)" class="member-name-link">update</a><wbr>(int[] key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a int[] key and U value.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D,U)" class="member-name-link">update</a><wbr>(long[] key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a long[] key and U value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long,U)" class="member-name-link">update</a><wbr>(long key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a long key and U value.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String,U)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a String key and U value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.nio.ByteBuffer,U)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a ByteBuffer and U value + The value is passed to the update() method of the Summary object associated with the key</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.Sketch">Methods inherited from class org.apache.datasketches.tuple.<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> +<code><a href="Sketch.html#getEstimate()">getEstimate</a>, <a href="Sketch.html#getEstimate(int)">getEstimate</a>, <a href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="Sketch.html#getLowerBound(int,int)">getLowerBound</a>, <a href="Sketch.html#getSummaryFactory()">getSummaryFactory</a>, <a href="Sketch.html#getTheta()">getTheta</a>, <a href="Sketch.html#getThetaLong()">getThetaLong</a>, <a href="Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="Sketch.html#getUpperBound(int,int)">getUpperBound</a>, <a href="Sketch.html#isEmpty()">isEmpty</a>, <a href="Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="Sketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int,int,float,org.apache.datasketches.tuple.SummaryFactory)"> +<h3>UpdatableSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">UpdatableSketch</span><wbr><span class="parameters">(int nomEntries, + int lgResizeFactor, + float samplingProbability, + <a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> summaryFactory)</span></div> +<div class="block">This is to create a new instance of an UpdatableQuickSelectSketch.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Nominal number of entries. Forced to the nearest power of 2 greater than + or equal to the given value.</dd> +<dd><code>lgResizeFactor</code> - log2(resizeFactor) - value from 0 to 3: + <pre> + 0 - no resizing (max size allocated), + 1 - double internal hash table each time it reaches a threshold + 2 - grow four times + 3 - grow eight times (default) + </pre></dd> +<dd><code>samplingProbability</code> - <a href="../../../../resources/dictionary.html#p">See Sampling Probability</a></dd> +<dd><code>summaryFactory</code> - An instance of a SummaryFactory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)"> +<h3>UpdatableSketch</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="element-name">UpdatableSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + <a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> deserializer, + <a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> summaryFactory)</span></div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +<div class="block">This is to create an instance of a sketch given a serialized form</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - Memory object with data of a serialized UpdatableSketch</dd> +<dd><code>deserializer</code> - instance of SummaryDeserializer</dd> +<dd><code>summaryFactory</code> - instance of SummaryFactory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.UpdatableSketch)"> +<h3>UpdatableSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">UpdatableSketch</span><wbr><span class="parameters">(<a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> sketch)</span></div> +<div class="block">Copy Constructor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - the sketch to copy</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>></span> <span class="element-name">copy</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a deep copy of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long,U)"> +<h3 id="update(long,java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</span></div> +<div class="block">Updates this sketch with a long key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given long key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double,U)"> +<h3 id="update(double,java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</span></div> +<div class="block">Updates this sketch with a double key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given double key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String,U)"> +<h3 id="update(java.lang.String,java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</span></div> +<div class="block">Updates this sketch with a String key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given String key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[],U)"> +<h3 id="update(byte[],java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</span></div> +<div class="block">Updates this sketch with a byte[] key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given byte[] key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.nio.ByteBuffer,U)"> +<h3 id="update(java.nio.ByteBuffer,java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</span></div> +<div class="block">Updates this sketch with a ByteBuffer and U value + The value is passed to the update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>buffer</code> - The given ByteBuffer key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[],U)"> +<h3 id="update(int[],java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(int[] key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</span></div> +<div class="block">Updates this sketch with a int[] key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given int[] key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[],U)"> +<h3 id="update(long[],java.lang.Object)">update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] key, + <a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a> value)</span></div> +<div class="block">Updates this sketch with a long[] key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given long[] key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#getRetainedEntries()">getRetainedEntries</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#getCountLessThanThetaLong(long)">Sketch</a></code></span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNominalEntries()"> +<h3>getNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNominalEntries</span>()</div> +<div class="block">Get configured nominal number of entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>nominal number of entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Get log_base2 of Nominal Entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>log_base2 of Nominal Entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamplingProbability()"> +<h3>getSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getSamplingProbability</span>()</div> +<div class="block">Get configured sampling probability</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>sampling probability</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentCapacity()"> +<h3>getCurrentCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentCapacity</span>()</div> +<div class="block">Get current capacity</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>current capacity</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Get configured resize factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>resize factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="trim()"> +<h3>trim</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">trim</span>()</div> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch an empty state.</div> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>></span> <span class="element-name">compact</span>()</div> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#compact()">compact</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>compact sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</div> +</div> +<div class="block">This serializes an UpdatableSketch (QuickSelectSketch).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#toByteArray()">toByteArray</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of an UpdatableSketch (QuickSelectSketch).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Sketch.html#iterator()">Sketch</a></code></span></div> +<div class="block">Returns a SketchIterator</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Sketch.html#iterator()">iterator</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>a SketchIterator</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSketchBuilder.html new file mode 100644 index 000000000..32e4a072d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSketchBuilder.html @@ -0,0 +1,254 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UpdatableSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: UpdatableSketchBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UpdatableSketchBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class UpdatableSketchBuilder" class="title">Class UpdatableSketchBuilder<U,<wbr>S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.UpdatableSketchBuilder<U,<wbr>S></div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>U</code> - Type of update value</dd> +<dd><code>S</code> - Type of Summary</dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">UpdatableSketchBuilder<U,<wbr>S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">For building a new generic tuple UpdatableSketch</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketchBuilder</a><wbr>(<a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of UpdatableSketchBuilder with default parameters</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an UpdatableSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets the Nominal Entries, Resize Factor and Sampling Probability to their default values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set the nominal number of entries.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set the resize factor.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSamplingProbability(float)" class="member-name-link">setSamplingProbability</a><wbr>(float samplingProbability)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set sampling probability.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.SummaryFactory)"> +<h3>UpdatableSketchBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">UpdatableSketchBuilder</span><wbr><span class="parameters">(<a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>> summaryFactory)</span></div> +<div class="block">Creates an instance of UpdatableSketchBuilder with default parameters</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summaryFactory</code> - An instance of SummaryFactory.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setNominalEntries(int)"> +<h3>setNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></span> <span class="element-name">setNominalEntries</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">This is to set the nominal number of entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Nominal number of entries. Forced to the nearest power of 2 greater than + or equal to the given value.</dd> +<dt>Returns:</dt> +<dd>this UpdatableSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setResizeFactor(org.apache.datasketches.common.ResizeFactor)"> +<h3>setResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></span> <span class="element-name">setResizeFactor</span><wbr><span class="parameters">(<a href="../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</span></div> +<div class="block">This is to set the resize factor. + Value of X1 means that the maximum capacity is allocated from the start. + Default resize factor is X8.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>resizeFactor</code> - value of X1, X2, X4 or X8</dd> +<dt>Returns:</dt> +<dd>this UpdatableSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setSamplingProbability(float)"> +<h3>setSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></span> <span class="element-name">setSamplingProbability</span><wbr><span class="parameters">(float samplingProbability)</span></div> +<div class="block">This is to set sampling probability. + Default probability is 1.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>samplingProbability</code> - sampling probability from 0 to 1</dd> +<dt>Returns:</dt> +<dd>this UpdatableSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build()"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></span> <span class="element-name">build</span>()</div> +<div class="block">Returns an UpdatableSketch with the current configuration of this Builder.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an UpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets the Nominal Entries, Resize Factor and Sampling Probability to their default values. + The assignment of <i>U</i> and <i>S</i> remain the same.</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSummary.html new file mode 100644 index 000000000..8c7c7ce54 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/UpdatableSummary.html @@ -0,0 +1,156 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>UpdatableSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, interface: UpdatableSummary"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/UpdatableSummary.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Interface UpdatableSummary" class="title">Interface UpdatableSummary<U></h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>U</code> - type of update value</dd> +</dl> +<dl class="notes"> +<dt>All Superinterfaces:</dt> +<dd><code><a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></dd> +</dl> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code>, <code><a href="adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code>, <code><a href="aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">UpdatableSummary<U></span><span class="extends-implements"> +extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="block">Interface for updating user-defined Summary</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(U)" class="member-name-link">update</a><wbr>(<a href="UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">This is to provide a method of updating summaries.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.Summary">Methods inherited from interface org.apache.datasketches.tuple.<a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></h3> +<code><a href="Summary.html#copy()">copy</a>, <a href="Summary.html#toByteArray()">toByteArray</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(U)"> +<h3 id="update(java.lang.Object)">update</h3> +<div class="member-signature"><span class="return-type"><a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a>></span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a> value)</span></div> +<div class="block">This is to provide a method of updating summaries. + This is primarily used internally.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - update value</dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/Util.html b/docs/7.0.X/org/apache/datasketches/tuple/Util.html new file mode 100644 index 000000000..7e56d1ee9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/Util.html @@ -0,0 +1,343 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Util (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple, class: Util"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/Util.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple</a></div> +<h1 title="Class Util" class="title">Class Util</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.Util</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Util</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Common utility functions for Tuples</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Util</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkSeedHashes(short,short)" class="member-name-link">checkSeedHashes</a><wbr>(short seedHashA, + short seedHashB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Checks the two given seed hashes.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static short</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeSeedHash(long)" class="member-name-link">computeSeedHash</a><wbr>(long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Computes and checks the 16-bit seed hash from the given long seed.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#copySummaryArray(S%5B%5D)" class="member-name-link">copySummaryArray</a><wbr>(S[] summaryArr)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final long[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#doubleToLongArray(double)" class="member-name-link">doubleToLongArray</a><wbr>(double value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Converts a <i>double</i> to a <i>long[]</i>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStartingCapacity(int,int)" class="member-name-link">getStartingCapacity</a><wbr>(int nomEntries, + int lgResizeFactor)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Gets the starting capacity of a new sketch given the Nominal Entries and the log Resize Factor.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newSummaryArray(S%5B%5D,int)" class="member-name-link">newSummaryArray</a><wbr>(S[] summaryArr, + int length)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates a new Summary Array with the specified length</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringArrHash(java.lang.String%5B%5D)" class="member-name-link">stringArrHash</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArray)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringConcat(java.lang.String%5B%5D)" class="member-name-link">stringConcat</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Concatenate array of Strings to a single String.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringHash(java.lang.String)" class="member-name-link">stringHash</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringToByteArray(java.lang.String)" class="member-name-link">stringToByteArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Converts a String to a UTF_8 byte array.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>Util</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Util</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="doubleToLongArray(double)"> +<h3>doubleToLongArray</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long[]</span> <span class="element-name">doubleToLongArray</span><wbr><span class="parameters">(double value)</span></div> +<div class="block">Converts a <i>double</i> to a <i>long[]</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - the given double value</dd> +<dt>Returns:</dt> +<dd>the long array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="stringToByteArray(java.lang.String)"> +<h3>stringToByteArray</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">byte[]</span> <span class="element-name">stringToByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> +<div class="block">Converts a String to a UTF_8 byte array. If the given value is either null or empty this + method returns null.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>value</code> - the given String value</dd> +<dt>Returns:</dt> +<dd>the UTF_8 byte array</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="computeSeedHash(long)"> +<h3>computeSeedHash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">short</span> <span class="element-name">computeSeedHash</span><wbr><span class="parameters">(long seed)</span></div> +<div class="block">Computes and checks the 16-bit seed hash from the given long seed. + The seed hash may not be zero in order to maintain compatibility with older serialized + versions that did not have this concept.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seed</code> - <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a></dd> +<dt>Returns:</dt> +<dd>the seed hash.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="checkSeedHashes(short,short)"> +<h3>checkSeedHashes</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">void</span> <span class="element-name">checkSeedHashes</span><wbr><span class="parameters">(short seedHashA, + short seedHashB)</span></div> +<div class="block">Checks the two given seed hashes. If they are not equal, this method throws an Exception.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seedHashA</code> - given seed hash A</dd> +<dd><code>seedHashB</code> - given seed hash B</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getStartingCapacity(int,int)"> +<h3>getStartingCapacity</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getStartingCapacity</span><wbr><span class="parameters">(int nomEntries, + int lgResizeFactor)</span></div> +<div class="block">Gets the starting capacity of a new sketch given the Nominal Entries and the log Resize Factor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - the given Nominal Entries</dd> +<dd><code>lgResizeFactor</code> - the given log Resize Factor</dd> +<dt>Returns:</dt> +<dd>the starting capacity</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="stringConcat(java.lang.String[])"> +<h3>stringConcat</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">stringConcat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArr)</span></div> +<div class="block">Concatenate array of Strings to a single String.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>strArr</code> - the given String array</dd> +<dt>Returns:</dt> +<dd>the concatenated String</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="stringHash(java.lang.String)"> +<h3>stringHash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">stringHash</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>s</code> - the string to hash</dd> +<dt>Returns:</dt> +<dd>the hash of the string</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="stringArrHash(java.lang.String[])"> +<h3>stringArrHash</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">stringArrHash</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArray)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>strArray</code> - array of Strings</dd> +<dt>Returns:</dt> +<dd>long hash of concatenated strings.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copySummaryArray(S[])"> +<h3 id="copySummaryArray(org.apache.datasketches.tuple.Summary[])">copySummaryArray</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">S[]</span> <span class="element-name">copySummaryArray</span><wbr><span class="parameters">(S[] summaryArr)</span></div> +<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - type of summary</dd> +<dt>Parameters:</dt> +<dd><code>summaryArr</code> - the given summary array or table</dd> +<dt>Returns:</dt> +<dd>the copy</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="newSummaryArray(S[],int)"> +<h3 id="newSummaryArray(org.apache.datasketches.tuple.Summary[],int)">newSummaryArray</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> <span class="return-type">S[]</span> <span class="element-name">newSummaryArray</span><wbr><span class="parameters">(S[] summaryArr, + int length)</span></div> +<div class="block">Creates a new Summary Array with the specified length</div> +<dl class="notes"> +<dt>Type Parameters:</dt> +<dd><code>S</code> - the summary class type</dd> +<dt>Parameters:</dt> +<dd><code>summaryArr</code> - example array, only used to obtain the component type. It has no data.</dd> +<dd><code>length</code> - the desired length of the returned array.</dd> +<dt>Returns:</dt> +<dd>a new Summary Array with the specified length</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSketch.html new file mode 100644 index 000000000..ade90fea3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSketch.html @@ -0,0 +1,485 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoubleSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.adouble, class: DoubleSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoubleSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<h1 title="Class DoubleSketch" class="title">Class DoubleSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S> +<div class="inheritance"><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>,<wbr><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>> +<div class="inheritance">org.apache.datasketches.tuple.adouble.DoubleSketch</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DoubleSketch</span> +<span class="extends-implements">extends <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>,<wbr><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch</a><wbr>(int lgK, + int lgResizeFactor, + float samplingProbability, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates this sketch with the following parameters:</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch</a><wbr>(int lgK, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentCapacity()" class="member-name-link">getCurrentCapacity</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get current capacity</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get log_base2 of Nominal Entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNominalEntries()" class="member-name-link">getNominalEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured nominal number of entries</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured resize factor</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplingProbability()" class="member-name-link">getSamplingProbability</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured sampling probability</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SketchIterator</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch an empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trim()" class="member-name-link">trim</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long,java.lang.Double)" class="member-name-link">update</a><wbr>(long key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a long key and U value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String,java.lang.Double)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a String key and U value.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.UpdatableSketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></h3> +<code><a href="../UpdatableSketch.html#copy()">copy</a>, <a href="../UpdatableSketch.html#update(byte%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(double,U)">update</a>, <a href="../UpdatableSketch.html#update(int%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(long%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(java.nio.ByteBuffer,U)">update</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.Sketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> +<code><a href="../Sketch.html#getEstimate()">getEstimate</a>, <a href="../Sketch.html#getEstimate(int)">getEstimate</a>, <a href="../Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="../Sketch.html#getLowerBound(int,int)">getLowerBound</a>, <a href="../Sketch.html#getSummaryFactory()">getSummaryFactory</a>, <a href="../Sketch.html#getTheta()">getTheta</a>, <a href="../Sketch.html#getThetaLong()">getThetaLong</a>, <a href="../Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="../Sketch.html#getUpperBound(int,int)">getUpperBound</a>, <a href="../Sketch.html#isEmpty()">isEmpty</a>, <a href="../Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="../Sketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"> +<h3>DoubleSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSketch</span><wbr><span class="parameters">(int lgK, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</span></div> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - Log_base2 of <i>Nominal Entries</i>. + <a href="../../../../../resources/dictionary.html#nomEntries">See Nominal Entries</a></dd> +<dd><code>mode</code> - The DoubleSummary mode to be used</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,int,float,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"> +<h3>DoubleSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSketch</span><wbr><span class="parameters">(int lgK, + int lgResizeFactor, + float samplingProbability, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</span></div> +<div class="block">Creates this sketch with the following parameters:</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - Log_base2 of <i>Nominal Entries</i>.</dd> +<dd><code>lgResizeFactor</code> - log2(resizeFactor) - value from 0 to 3: + <pre> + 0 - no resizing (max size allocated), + 1 - double internal hash table each time it reaches a threshold + 2 - grow four times + 3 - grow eight times (default) + </pre></dd> +<dd><code>samplingProbability</code> - <a href="../../../../../resources/dictionary.html#p">See Sampling Probability</a></dd> +<dd><code>mode</code> - The DoubleSummary mode to be used</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"> +<h3>DoubleSketch</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="element-name">DoubleSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</span></div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +<div class="block">Constructs this sketch from a Memory image, which must be from an DoubleSketch, and + usually with data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>mode</code> - The DoubleSummary mode to be used</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(java.lang.String,java.lang.Double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../UpdatableSketch.html#update(java.lang.String,U)">UpdatableSketch</a></code></span></div> +<div class="block">Updates this sketch with a String key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="../UpdatableSketch.html#update(java.lang.String,U)">update</a></code> in class <code><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>,<wbr><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>key</code> - The given String key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long,java.lang.Double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../UpdatableSketch.html#update(long,U)">UpdatableSketch</a></code></span></div> +<div class="block">Updates this sketch with a long key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="../UpdatableSketch.html#update(long,U)">update</a></code> in class <code><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>,<wbr><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>key</code> - The given long key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#getRetainedEntries()">getRetainedEntries</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../Sketch.html#getCountLessThanThetaLong(long)">Sketch</a></code></span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNominalEntries()"> +<h3>getNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNominalEntries</span>()</div> +<div class="block">Get configured nominal number of entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>nominal number of entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Get log_base2 of Nominal Entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>log_base2 of Nominal Entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamplingProbability()"> +<h3>getSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getSamplingProbability</span>()</div> +<div class="block">Get configured sampling probability</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>sampling probability</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentCapacity()"> +<h3>getCurrentCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentCapacity</span>()</div> +<div class="block">Get current capacity</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>current capacity</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Get configured resize factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>resize factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="trim()"> +<h3>trim</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">trim</span>()</div> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch an empty state.</div> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span> <span class="element-name">compact</span>()</div> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#compact()">compact</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>compact sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</div> +</div> +<div class="block">This serializes an UpdatableSketch (QuickSelectSketch).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#toByteArray()">toByteArray</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of an UpdatableSketch (QuickSelectSketch).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../Sketch.html#iterator()">Sketch</a></code></span></div> +<div class="block">Returns a SketchIterator</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#iterator()">iterator</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>a SketchIterator</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html new file mode 100644 index 000000000..174afa290 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html @@ -0,0 +1,263 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoubleSummary.Mode (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.adouble, class: DoubleSummary, enum: Mode"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoubleSummary.Mode.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<h1 title="Enum Class DoubleSummary.Mode" class="title">Enum Class DoubleSummary.Mode</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a>> +<div class="inheritance">org.apache.datasketches.tuple.adouble.DoubleSummary.Mode</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">DoubleSummary.Mode</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a>></span></div> +<div class="block">The aggregation modes for this Summary</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#AlwaysOne" class="member-name-link">AlwaysOne</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The aggregation mode is always one.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Max" class="member-name-link">Max</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The aggregation mode is the maximum function.</div> +</div> +<div class="col-first even-row-color"><code><a href="#Min" class="member-name-link">Min</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The aggregation mode is the minimum function.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Sum" class="member-name-link">Sum</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The aggregation mode is the summation function.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="Sum"> +<h3>Sum</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span> <span class="element-name">Sum</span></div> +<div class="block">The aggregation mode is the summation function. + + <p>New retained value = previous retained value + incoming value</p></div> +</section> +</li> +<li> +<section class="detail" id="Min"> +<h3>Min</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span> <span class="element-name">Min</span></div> +<div class="block">The aggregation mode is the minimum function. + + <p>New retained value = min(previous retained value, incoming value)</p></div> +</section> +</li> +<li> +<section class="detail" id="Max"> +<h3>Max</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span> <span class="element-name">Max</span></div> +<div class="block">The aggregation mode is the maximum function. + + <p>New retained value = max(previous retained value, incoming value)</p></div> +</section> +</li> +<li> +<section class="detail" id="AlwaysOne"> +<h3>AlwaysOne</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span> <span class="element-name">AlwaysOne</span></div> +<div class="block">The aggregation mode is always one. + + <p>New retained value = 1.0</p></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummary.html new file mode 100644 index 000000000..01c9fa169 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummary.html @@ -0,0 +1,284 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoubleSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.adouble, class: DoubleSummary"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoubleSummary.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<h1 title="Class DoubleSummary" class="title">Class DoubleSummary</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.adouble.DoubleSummary</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code>, <code><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DoubleSummary</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span></div> +<div class="block">Summary for generic tuple sketches of type Double. + This summary keeps a double value. On update a predefined operation is performed depending on + the mode. + Supported modes: Sum, Min, Max, AlwaysOne, Increment. The default mode is Sum.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="DoubleSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The aggregation modes for this Summary</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummary</a><wbr>(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of DoubleSummary with a given mode.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deep copy.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates an instance of the DoubleSummary given a serialized representation</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValue()" class="member-name-link">getValue</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to serialize a Summary instance to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.Double)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to provide a method of updating summaries.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"> +<h3>DoubleSummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSummary</span><wbr><span class="parameters">(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</span></div> +<div class="block">Creates an instance of DoubleSummary with a given mode.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mode</code> - update mode</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(java.lang.Double)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../UpdatableSummary.html#update(U)">UpdatableSummary</a></code></span></div> +<div class="block">This is to provide a method of updating summaries. + This is primarily used internally.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../UpdatableSummary.html#update(U)">update</a></code> in interface <code><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>value</code> - update value</dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span> <span class="element-name">copy</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Summary.html#copy()">Summary</a></code></span></div> +<div class="block">Deep copy. + + <p><b>Caution:</b> This must implement a deep copy.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Summary.html#copy()">copy</a></code> in interface <code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></dd> +<dt>Returns:</dt> +<dd>deep copy of the Summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getValue()"> +<h3>getValue</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getValue</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>current value of the DoubleSummary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Summary.html#toByteArray()">Summary</a></code></span></div> +<div class="block">This is to serialize a Summary instance to a byte array. + + <p>The user should encode in the byte array its total size, which is used during + deserialization, especially if the Summary has variable sized elements.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Summary.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of the Summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="fromMemory(org.apache.datasketches.memory.Memory)"> +<h3>fromMemory</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span> <span class="element-name">fromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Creates an instance of the DoubleSummary given a serialized representation</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object with serialized DoubleSummary</dd> +<dt>Returns:</dt> +<dd>DeserializedResult object, which contains a DoubleSummary object and number of bytes + read from the Memory</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html new file mode 100644 index 000000000..1f084a9c0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html @@ -0,0 +1,189 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoubleSummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.adouble, class: DoubleSummaryDeserializer"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoubleSummaryDeserializer.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<h1 title="Class DoubleSummaryDeserializer" class="title">Class DoubleSummaryDeserializer</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.adouble.DoubleSummaryDeserializer</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DoubleSummaryDeserializer</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">DoubleSummaryDeserializer</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to create an instance of a Summary given a serialized representation.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>DoubleSummaryDeserializer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSummaryDeserializer</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapifySummary(org.apache.datasketches.memory.Memory)"> +<h3>heapifySummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span> <span class="element-name">heapifySummary</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)">SummaryDeserializer</a></code></span></div> +<div class="block">This is to create an instance of a Summary given a serialized representation. + The user may assume that the start of the given Memory is the correct place to start + deserializing. However, the user must be able to determine the number of bytes required to + deserialize the summary as the capacity of the given Memory may + include multiple such summaries and may be much larger than required for a single summary.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)">heapifySummary</a></code> in interface <code><a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object with serialized representation of a Summary</dd> +<dt>Returns:</dt> +<dd>DeserializedResult object, which contains a Summary object and number of bytes read + from the Memory</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html new file mode 100644 index 000000000..3357ccae4 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html @@ -0,0 +1,186 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoubleSummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.adouble, class: DoubleSummaryFactory"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<h1 title="Class DoubleSummaryFactory" class="title">Class DoubleSummaryFactory</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.adouble.DoubleSummaryFactory</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DoubleSummaryFactory</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span></div> +<div class="block">Factory for DoubleSummary.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummaryFactory</a><wbr>(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> summaryMode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of DoubleSummaryFactory with a given mode</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newSummary()" class="member-name-link">newSummary</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"> +<h3>DoubleSummaryFactory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSummaryFactory</span><wbr><span class="parameters">(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> summaryMode)</span></div> +<div class="block">Creates an instance of DoubleSummaryFactory with a given mode</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summaryMode</code> - summary mode</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newSummary()"> +<h3>newSummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span> <span class="element-name">newSummary</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummaryFactory.html#newSummary()">newSummary</a></code> in interface <code><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +<dt>Returns:</dt> +<dd>new instance of Summary</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html new file mode 100644 index 000000000..3615b0469 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html @@ -0,0 +1,258 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>DoubleSummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.adouble, class: DoubleSummarySetOperations"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/DoubleSummarySetOperations.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<h1 title="Class DoubleSummarySetOperations" class="title">Class DoubleSummarySetOperations</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.adouble.DoubleSummarySetOperations</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DoubleSummarySetOperations</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></span></div> +<div class="block">Methods for defining how unions and intersections of two objects of type DoubleSummary + are performed.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">DoubleSummarySetOperations</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance with default mode of <i>sum</i> for both union and intersection.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummarySetOperations</a><wbr>(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> summaryMode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an instance given a DoubleSummary update mode where the mode is the same for both + union and intersection.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummarySetOperations</a><wbr>(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> unionSummaryMode, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> intersectionSummaryMode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance with two modes.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersection(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">intersection</a><wbr>(<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is called by the intersection operator when both sketches have the same hash value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">union</a><wbr>(<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is called by the union operator when both sketches have the same hash value.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>DoubleSummarySetOperations</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSummarySetOperations</span>()</div> +<div class="block">Creates an instance with default mode of <i>sum</i> for both union and intersection. + This exists for backward compatibility.</div> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"> +<h3>DoubleSummarySetOperations</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSummarySetOperations</span><wbr><span class="parameters">(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> summaryMode)</span></div> +<div class="block">Creates an instance given a DoubleSummary update mode where the mode is the same for both + union and intersection. This exists for backward compatibility.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summaryMode</code> - DoubleSummary update mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)"> +<h3>DoubleSummarySetOperations</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DoubleSummarySetOperations</span><wbr><span class="parameters">(<a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> unionSummaryMode, + <a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> intersectionSummaryMode)</span></div> +<div class="block">Creates an instance with two modes.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>unionSummaryMode</code> - for unions</dd> +<dd><code>intersectionSummaryMode</code> - for intersections</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="union(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#union(S,S)">SummarySetOperations</a></code></span></div> +<div class="block">This is called by the union operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummarySetOperations.html#union(S,S)">union</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>union of Summary A and Summary B</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersection(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)"> +<h3>intersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span> <span class="element-name">intersection</span><wbr><span class="parameters">(<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#intersection(S,S)">SummarySetOperations</a></code></span></div> +<div class="block">This is called by the intersection operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummarySetOperations.html#intersection(S,S)">intersection</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>intersection of Summary A and Summary B</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSketch.html new file mode 100644 index 000000000..15cadf1ec --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSketch.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.adouble.DoubleSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.adouble, class: DoubleSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.adouble.DoubleSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.adouble.DoubleSketch</h1> +</div> +No usage of org.apache.datasketches.tuple.adouble.DoubleSketch</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummary.Mode.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummary.Mode.html new file mode 100644 index 000000000..f4bc8280c --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummary.Mode.html @@ -0,0 +1,147 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.tuple.adouble.DoubleSummary.Mode (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.adouble, class: DoubleSummary, enum: Mode"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.tuple.adouble.DoubleSummary.Mode" class="title">Uses of Enum Class<br>org.apache.datasketches.tuple.adouble.DoubleSummary.Mode</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.adouble</a> that return <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoubleSummary.Mode.</span><code><a href="../DoubleSummary.Mode.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoubleSummary.Mode.</span><code><a href="../DoubleSummary.Mode.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple.adouble</a> with parameters of type <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../DoubleSketch.html#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch</a><wbr>(int lgK, + int lgResizeFactor, + float samplingProbability, + <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates this sketch with the following parameters:</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../DoubleSketch.html#%3Cinit%3E(int,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch</a><wbr>(int lgK, + <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../DoubleSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../DoubleSummary.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummary</a><wbr>(<a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> mode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an instance of DoubleSummary with a given mode.</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../DoubleSummaryFactory.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummaryFactory</a><wbr>(<a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> summaryMode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of DoubleSummaryFactory with a given mode</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../DoubleSummarySetOperations.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummarySetOperations</a><wbr>(<a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> summaryMode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an instance given a DoubleSummary update mode where the mode is the same for both + union and intersection.</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../DoubleSummarySetOperations.html#%3Cinit%3E(org.apache.datasketches.tuple.adouble.DoubleSummary.Mode,org.apache.datasketches.tuple.adouble.DoubleSummary.Mode)" class="member-name-link">DoubleSummarySetOperations</a><wbr>(<a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> unionSummaryMode, + <a href="../DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a> intersectionSummaryMode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance with two modes.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummary.html new file mode 100644 index 000000000..64a21ce79 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummary.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.adouble, class: DoubleSummary"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummary" class="title">Uses of Class<br>org.apache.datasketches.tuple.adouble.DoubleSummary</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.adouble</a> that return <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoubleSummary.</span><code><a href="../DoubleSummary.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoubleSummarySetOperations.</span><code><a href="../DoubleSummarySetOperations.html#intersection(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">intersection</a><wbr>(<a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoubleSummaryFactory.</span><code><a href="../DoubleSummaryFactory.html#newSummary()" class="member-name-link">newSummary</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoubleSummarySetOperations.</span><code><a href="../DoubleSummarySetOperations.html#union(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">union</a><wbr>(<a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoubleSummary.</span><code><a href="../DoubleSummary.html#update(java.lang.Double)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.adouble</a> that return types with arguments of type <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoubleSummary.</span><code><a href="../DoubleSummary.html#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of the DoubleSummary given a serialized representation</div> +</div> +<div class="col-first odd-row-color"><code><a href="../../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoubleSummaryDeserializer.</span><code><a href="../DoubleSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.adouble</a> with parameters of type <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoubleSummarySetOperations.</span><code><a href="../DoubleSummarySetOperations.html#intersection(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">intersection</a><wbr>(<a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoubleSummarySetOperations.</span><code><a href="../DoubleSummarySetOperations.html#union(org.apache.datasketches.tuple.adouble.DoubleSummary,org.apache.datasketches.tuple.adouble.DoubleSummary)" class="member-name-link">union</a><wbr>(<a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> a, + <a href="../DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummaryDeserializer.html new file mode 100644 index 000000000..82805586b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummaryDeserializer.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.adouble, class: DoubleSummaryDeserializer"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoubleSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.adouble">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummaryDeserializer" class="title">Uses of Class<br>org.apache.datasketches.tuple.adouble.DoubleSummaryDeserializer</h1> +</div> +No usage of org.apache.datasketches.tuple.adouble.DoubleSummaryDeserializer</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummaryFactory.html new file mode 100644 index 000000000..543b95068 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummaryFactory.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.adouble, class: DoubleSummaryFactory"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoubleSummaryFactory.html" title="class in org.apache.datasketches.tuple.adouble">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummaryFactory" class="title">Uses of Class<br>org.apache.datasketches.tuple.adouble.DoubleSummaryFactory</h1> +</div> +No usage of org.apache.datasketches.tuple.adouble.DoubleSummaryFactory</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummarySetOperations.html new file mode 100644 index 000000000..0377d36b0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/class-use/DoubleSummarySetOperations.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.adouble, class: DoubleSummarySetOperations"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.adouble.DoubleSummarySetOperations" class="title">Uses of Class<br>org.apache.datasketches.tuple.adouble.DoubleSummarySetOperations</h1> +</div> +No usage of org.apache.datasketches.tuple.adouble.DoubleSummarySetOperations</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-summary.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-summary.html new file mode 100644 index 000000000..7d58d4b91 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-summary.html @@ -0,0 +1,142 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.adouble (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.adouble"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.tuple.adouble" class="title">Package org.apache.datasketches.tuple.adouble</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.tuple.adouble</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first even-row-color"><a href="../arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +<div class="col-first odd-row-color"><a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> </div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Summary for generic tuple sketches of type Double.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="DoubleSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">The aggregation modes for this Summary</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoubleSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> </div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DoubleSummaryFactory.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Factory for DoubleSummary.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Methods for defining how unions and intersections of two objects of type DoubleSummary + are performed.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-tree.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-tree.html new file mode 100644 index 000000000..7efc56a32 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-tree.html @@ -0,0 +1,102 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.adouble Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.tuple.adouble"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.tuple.adouble</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="DoubleSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> (implements org.apache.datasketches.tuple.<a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>)</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="DoubleSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a> (implements org.apache.datasketches.tuple.<a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="DoubleSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a> (implements org.apache.datasketches.tuple.<a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="DoubleSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a> (implements org.apache.datasketches.tuple.<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.<a href="../Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><S> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="../UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S> +<ul> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="DoubleSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="DoubleSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-use.html b/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-use.html new file mode 100644 index 000000000..5452f91e7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/adouble/package-use.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.tuple.adouble (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.adouble"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.tuple.adouble" class="title">Uses of Package<br>org.apache.datasketches.tuple.adouble</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a> used by <a href="package-summary.html">org.apache.datasketches.tuple.adouble</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/DoubleSummary.html#org.apache.datasketches.tuple.adouble">DoubleSummary</a></div> +<div class="col-last even-row-color"> +<div class="block">Summary for generic tuple sketches of type Double.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/DoubleSummary.Mode.html#org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></div> +<div class="col-last odd-row-color"> +<div class="block">The aggregation modes for this Summary</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSketch.html new file mode 100644 index 000000000..672c0af80 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSketch.html @@ -0,0 +1,485 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IntegerSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger, class: IntegerSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IntegerSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<h1 title="Class IntegerSketch" class="title">Class IntegerSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S> +<div class="inheritance"><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>> +<div class="inheritance">org.apache.datasketches.tuple.aninteger.IntegerSketch</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">IntegerSketch</span> +<span class="extends-implements">extends <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch</a><wbr>(int lgK, + int lgResizeFactor, + float samplingProbability, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates this sketch with the following parameters:</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch</a><wbr>(int lgK, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentCapacity()" class="member-name-link">getCurrentCapacity</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get current capacity</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get log_base2 of Nominal Entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNominalEntries()" class="member-name-link">getNominalEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured nominal number of entries</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured resize factor</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplingProbability()" class="member-name-link">getSamplingProbability</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured sampling probability</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SketchIterator</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch an empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trim()" class="member-name-link">trim</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long,java.lang.Integer)" class="member-name-link">update</a><wbr>(long key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a long key and U value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String,java.lang.Integer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a String key and U value.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.UpdatableSketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></h3> +<code><a href="../UpdatableSketch.html#copy()">copy</a>, <a href="../UpdatableSketch.html#update(byte%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(double,U)">update</a>, <a href="../UpdatableSketch.html#update(int%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(long%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(java.nio.ByteBuffer,U)">update</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.Sketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> +<code><a href="../Sketch.html#getEstimate()">getEstimate</a>, <a href="../Sketch.html#getEstimate(int)">getEstimate</a>, <a href="../Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="../Sketch.html#getLowerBound(int,int)">getLowerBound</a>, <a href="../Sketch.html#getSummaryFactory()">getSummaryFactory</a>, <a href="../Sketch.html#getTheta()">getTheta</a>, <a href="../Sketch.html#getThetaLong()">getThetaLong</a>, <a href="../Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="../Sketch.html#getUpperBound(int,int)">getUpperBound</a>, <a href="../Sketch.html#isEmpty()">isEmpty</a>, <a href="../Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="../Sketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(int,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"> +<h3>IntegerSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IntegerSketch</span><wbr><span class="parameters">(int lgK, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</span></div> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - Log_base2 of <i>Nominal Entries</i>. + <a href="../../../../../resources/dictionary.html#nomEntries">See Nominal Entries</a></dd> +<dd><code>mode</code> - The IntegerSummary mode to be used</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,int,float,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"> +<h3>IntegerSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IntegerSketch</span><wbr><span class="parameters">(int lgK, + int lgResizeFactor, + float samplingProbability, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</span></div> +<div class="block">Creates this sketch with the following parameters:</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - Log_base2 of <i>Nominal Entries</i>.</dd> +<dd><code>lgResizeFactor</code> - log2(resizeFactor) - value from 0 to 3: + <pre> + 0 - no resizing (max size allocated), + 1 - double internal hash table each time it reaches a threshold + 2 - grow four times + 3 - grow eight times (default) + </pre></dd> +<dd><code>samplingProbability</code> - <a href="../../../../../resources/dictionary.html#p">See Sampling Probability</a></dd> +<dd><code>mode</code> - The IntegerSummary mode to be used</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"> +<h3>IntegerSketch</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="element-name">IntegerSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</span></div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +<div class="block">Constructs this sketch from a Memory image, which must be from an IntegerSketch, and + usually with data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>mode</code> - The IntegerSummary mode to be used</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(java.lang.String,java.lang.Integer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../UpdatableSketch.html#update(java.lang.String,U)">UpdatableSketch</a></code></span></div> +<div class="block">Updates this sketch with a String key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="../UpdatableSketch.html#update(java.lang.String,U)">update</a></code> in class <code><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>key</code> - The given String key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long,java.lang.Integer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long key, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../UpdatableSketch.html#update(long,U)">UpdatableSketch</a></code></span></div> +<div class="block">Updates this sketch with a long key and U value. + The value is passed to update() method of the Summary object associated with the key</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="../UpdatableSketch.html#update(long,U)">update</a></code> in class <code><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>key</code> - The given long key</dd> +<dd><code>value</code> - The given U value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#getRetainedEntries()">getRetainedEntries</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../Sketch.html#getCountLessThanThetaLong(long)">Sketch</a></code></span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNominalEntries()"> +<h3>getNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNominalEntries</span>()</div> +<div class="block">Get configured nominal number of entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>nominal number of entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Get log_base2 of Nominal Entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>log_base2 of Nominal Entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamplingProbability()"> +<h3>getSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getSamplingProbability</span>()</div> +<div class="block">Get configured sampling probability</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>sampling probability</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentCapacity()"> +<h3>getCurrentCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentCapacity</span>()</div> +<div class="block">Get current capacity</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>current capacity</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Get configured resize factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>resize factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="trim()"> +<h3>trim</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">trim</span>()</div> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch an empty state.</div> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span> <span class="element-name">compact</span>()</div> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#compact()">compact</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>compact sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</div> +</div> +<div class="block">This serializes an UpdatableSketch (QuickSelectSketch).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#toByteArray()">toByteArray</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of an UpdatableSketch (QuickSelectSketch).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../Sketch.html#iterator()">Sketch</a></code></span></div> +<div class="block">Returns a SketchIterator</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#iterator()">iterator</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>a SketchIterator</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html new file mode 100644 index 000000000..ff32c8d57 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html @@ -0,0 +1,263 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IntegerSummary.Mode (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummary, enum: Mode"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IntegerSummary.Mode.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<h1 title="Enum Class IntegerSummary.Mode" class="title">Enum Class IntegerSummary.Mode</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a>> +<div class="inheritance">org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">IntegerSummary.Mode</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a>></span></div> +<div class="block">The aggregation modes for this Summary</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#AlwaysOne" class="member-name-link">AlwaysOne</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The aggregation mode is always one.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Max" class="member-name-link">Max</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The aggregation mode is the maximum function.</div> +</div> +<div class="col-first even-row-color"><code><a href="#Min" class="member-name-link">Min</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The aggregation mode is the minimum function.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#Sum" class="member-name-link">Sum</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The aggregation mode is the summation function.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="Sum"> +<h3>Sum</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span> <span class="element-name">Sum</span></div> +<div class="block">The aggregation mode is the summation function. + + <p>New retained value = previous retained value + incoming value</p></div> +</section> +</li> +<li> +<section class="detail" id="Min"> +<h3>Min</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span> <span class="element-name">Min</span></div> +<div class="block">The aggregation mode is the minimum function. + + <p>New retained value = min(previous retained value, incoming value)</p></div> +</section> +</li> +<li> +<section class="detail" id="Max"> +<h3>Max</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span> <span class="element-name">Max</span></div> +<div class="block">The aggregation mode is the maximum function. + + <p>New retained value = max(previous retained value, incoming value)</p></div> +</section> +</li> +<li> +<section class="detail" id="AlwaysOne"> +<h3>AlwaysOne</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span> <span class="element-name">AlwaysOne</span></div> +<div class="block">The aggregation mode is always one. + + <p>New retained value = 1</p></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum class, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this class with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummary.html new file mode 100644 index 000000000..fbef45151 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummary.html @@ -0,0 +1,284 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IntegerSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummary"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IntegerSummary.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<h1 title="Class IntegerSummary" class="title">Class IntegerSummary</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.aninteger.IntegerSummary</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code>, <code><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">IntegerSummary</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span></div> +<div class="block">Summary for generic tuple sketches of type Integer. + This summary keeps an Integer value. On update a predefined operation is performed depending on + the mode. + Supported modes: Sum, Min, Max, AlwaysOne, Increment. The default mode is Sum.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="IntegerSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The aggregation modes for this Summary</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummary</a><wbr>(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of IntegerSummary with a given mode.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deep copy.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Creates an instance of the IntegerSummary given a serialized representation</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValue()" class="member-name-link">getValue</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to serialize a Summary instance to a byte array.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.Integer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to provide a method of updating summaries.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"> +<h3>IntegerSummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IntegerSummary</span><wbr><span class="parameters">(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</span></div> +<div class="block">Creates an instance of IntegerSummary with a given mode.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mode</code> - update mode. This should not be called by a user.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(java.lang.Integer)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../UpdatableSummary.html#update(U)">UpdatableSummary</a></code></span></div> +<div class="block">This is to provide a method of updating summaries. + This is primarily used internally.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../UpdatableSummary.html#update(U)">update</a></code> in interface <code><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>value</code> - update value</dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span> <span class="element-name">copy</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Summary.html#copy()">Summary</a></code></span></div> +<div class="block">Deep copy. + + <p><b>Caution:</b> This must implement a deep copy.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Summary.html#copy()">copy</a></code> in interface <code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></dd> +<dt>Returns:</dt> +<dd>deep copy of the Summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getValue()"> +<h3>getValue</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getValue</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>current value of the IntegerSummary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Summary.html#toByteArray()">Summary</a></code></span></div> +<div class="block">This is to serialize a Summary instance to a byte array. + + <p>The user should encode in the byte array its total size, which is used during + deserialization, especially if the Summary has variable sized elements.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Summary.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of the Summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="fromMemory(org.apache.datasketches.memory.Memory)"> +<h3>fromMemory</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span> <span class="element-name">fromMemory</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Creates an instance of the IntegerSummary given a serialized representation</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object with serialized IntegerSummary</dd> +<dt>Returns:</dt> +<dd>DeserializedResult object, which contains a IntegerSummary object and number of bytes + read from the Memory</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html new file mode 100644 index 000000000..31609e1ef --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html @@ -0,0 +1,189 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IntegerSummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummaryDeserializer"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IntegerSummaryDeserializer.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<h1 title="Class IntegerSummaryDeserializer" class="title">Class IntegerSummaryDeserializer</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.aninteger.IntegerSummaryDeserializer</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">IntegerSummaryDeserializer</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">IntegerSummaryDeserializer</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to create an instance of a Summary given a serialized representation.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>IntegerSummaryDeserializer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IntegerSummaryDeserializer</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapifySummary(org.apache.datasketches.memory.Memory)"> +<h3>heapifySummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span> <span class="element-name">heapifySummary</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)">SummaryDeserializer</a></code></span></div> +<div class="block">This is to create an instance of a Summary given a serialized representation. + The user may assume that the start of the given Memory is the correct place to start + deserializing. However, the user must be able to determine the number of bytes required to + deserialize the summary as the capacity of the given Memory may + include multiple such summaries and may be much larger than required for a single summary.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)">heapifySummary</a></code> in interface <code><a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object with serialized representation of a Summary</dd> +<dt>Returns:</dt> +<dd>DeserializedResult object, which contains a Summary object and number of bytes read + from the Memory</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html new file mode 100644 index 000000000..e18ff4a72 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html @@ -0,0 +1,186 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IntegerSummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummaryFactory"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IntegerSummaryFactory.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<h1 title="Class IntegerSummaryFactory" class="title">Class IntegerSummaryFactory</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.aninteger.IntegerSummaryFactory</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">IntegerSummaryFactory</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span></div> +<div class="block">Factory for IntegerSummary.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummaryFactory</a><wbr>(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> summaryMode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of IntegerSummaryFactory with a given mode</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newSummary()" class="member-name-link">newSummary</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"> +<h3>IntegerSummaryFactory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IntegerSummaryFactory</span><wbr><span class="parameters">(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> summaryMode)</span></div> +<div class="block">Creates an instance of IntegerSummaryFactory with a given mode</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>summaryMode</code> - summary mode</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newSummary()"> +<h3>newSummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span> <span class="element-name">newSummary</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummaryFactory.html#newSummary()">newSummary</a></code> in interface <code><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +<dt>Returns:</dt> +<dd>new instance of Summary</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html new file mode 100644 index 000000000..ec900cf50 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html @@ -0,0 +1,233 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>IntegerSummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummarySetOperations"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/IntegerSummarySetOperations.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<h1 title="Class IntegerSummarySetOperations" class="title">Class IntegerSummarySetOperations</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.aninteger.IntegerSummarySetOperations</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">IntegerSummarySetOperations</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span></div> +<div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary + are performed.</div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummarySetOperations</a><wbr>(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> unionSummaryMode, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> intersectionSummaryMode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates a new instance with two modes</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">intersection</a><wbr>(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is called by the intersection operator when both sketches have the same hash value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">union</a><wbr>(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is called by the union operator when both sketches have the same hash value.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"> +<h3>IntegerSummarySetOperations</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IntegerSummarySetOperations</span><wbr><span class="parameters">(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> unionSummaryMode, + <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> intersectionSummaryMode)</span></div> +<div class="block">Creates a new instance with two modes</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>unionSummaryMode</code> - for unions</dd> +<dd><code>intersectionSummaryMode</code> - for intersections</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#union(S,S)">SummarySetOperations</a></code></span></div> +<div class="block">This is called by the union operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummarySetOperations.html#union(S,S)">union</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>union of Summary A and Summary B</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)"> +<h3>intersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span> <span class="element-name">intersection</span><wbr><span class="parameters">(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#intersection(S,S)">SummarySetOperations</a></code></span></div> +<div class="block">This is called by the intersection operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummarySetOperations.html#intersection(S,S)">intersection</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>intersection of Summary A and Summary B</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSketch.html new file mode 100644 index 000000000..2c11837c5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSketch.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.aninteger, class: IntegerSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.aninteger.IntegerSketch</h1> +</div> +No usage of org.apache.datasketches.tuple.aninteger.IntegerSketch</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummary.Mode.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummary.Mode.html new file mode 100644 index 000000000..48c91e99d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummary.Mode.html @@ -0,0 +1,141 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummary, enum: Mode"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode" class="title">Uses of Enum Class<br>org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode</h1> +</div> +<div class="caption"><span>Packages that use <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.aninteger</a> that return <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IntegerSummary.Mode.</span><code><a href="../IntegerSummary.Mode.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a>[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">IntegerSummary.Mode.</span><code><a href="../IntegerSummary.Mode.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple.aninteger</a> with parameters of type <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../IntegerSketch.html#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch</a><wbr>(int lgK, + int lgResizeFactor, + float samplingProbability, + <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates this sketch with the following parameters:</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../IntegerSketch.html#%3Cinit%3E(int,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch</a><wbr>(int lgK, + <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs this sketch with given <i>lgK</i>.</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../IntegerSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last even-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../IntegerSummary.html#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummary</a><wbr>(<a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> mode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an instance of IntegerSummary with a given mode.</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../IntegerSummaryFactory.html#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummaryFactory</a><wbr>(<a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> summaryMode)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of IntegerSummaryFactory with a given mode</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../IntegerSummarySetOperations.html#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummarySetOperations</a><wbr>(<a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> unionSummaryMode, + <a href="../IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> intersectionSummaryMode)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates a new instance with two modes</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummary.html new file mode 100644 index 000000000..5d3b4b489 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummary.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummary"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummary" class="title">Uses of Class<br>org.apache.datasketches.tuple.aninteger.IntegerSummary</h1> +</div> +<div class="caption"><span>Packages that use <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.aninteger</a> that return <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IntegerSummary.</span><code><a href="../IntegerSummary.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">IntegerSummarySetOperations.</span><code><a href="../IntegerSummarySetOperations.html#intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">intersection</a><wbr>(<a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IntegerSummaryFactory.</span><code><a href="../IntegerSummaryFactory.html#newSummary()" class="member-name-link">newSummary</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">IntegerSummarySetOperations.</span><code><a href="../IntegerSummarySetOperations.html#union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">union</a><wbr>(<a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IntegerSummary.</span><code><a href="../IntegerSummary.html#update(java.lang.Integer)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.aninteger</a> that return types with arguments of type <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IntegerSummary.</span><code><a href="../IntegerSummary.html#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of the IntegerSummary given a serialized representation</div> +</div> +<div class="col-first odd-row-color"><code><a href="../../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">IntegerSummaryDeserializer.</span><code><a href="../IntegerSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.aninteger</a> with parameters of type <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IntegerSummarySetOperations.</span><code><a href="../IntegerSummarySetOperations.html#intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">intersection</a><wbr>(<a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">IntegerSummarySetOperations.</span><code><a href="../IntegerSummarySetOperations.html#union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">union</a><wbr>(<a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, + <a href="../IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummaryDeserializer.html new file mode 100644 index 000000000..b8182faaa --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummaryDeserializer.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummaryDeserializer"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IntegerSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.aninteger">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummaryDeserializer" class="title">Uses of Class<br>org.apache.datasketches.tuple.aninteger.IntegerSummaryDeserializer</h1> +</div> +No usage of org.apache.datasketches.tuple.aninteger.IntegerSummaryDeserializer</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummaryFactory.html new file mode 100644 index 000000000..85397d785 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummaryFactory.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummaryFactory"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IntegerSummaryFactory.html" title="class in org.apache.datasketches.tuple.aninteger">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummaryFactory" class="title">Uses of Class<br>org.apache.datasketches.tuple.aninteger.IntegerSummaryFactory</h1> +</div> +No usage of org.apache.datasketches.tuple.aninteger.IntegerSummaryFactory</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummarySetOperations.html new file mode 100644 index 000000000..b9099a49d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/class-use/IntegerSummarySetOperations.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummarySetOperations"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.aninteger.IntegerSummarySetOperations" class="title">Uses of Class<br>org.apache.datasketches.tuple.aninteger.IntegerSummarySetOperations</h1> +</div> +No usage of org.apache.datasketches.tuple.aninteger.IntegerSummarySetOperations</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-summary.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-summary.html new file mode 100644 index 000000000..dc2e16046 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-summary.html @@ -0,0 +1,142 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.aninteger (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.tuple.aninteger" class="title">Package org.apache.datasketches.tuple.aninteger</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.tuple.aninteger</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="../arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +<div class="col-first odd-row-color"><a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> </div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Summary for generic tuple sketches of type Integer.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab3"><a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></div> +<div class="col-last even-row-color class-summary class-summary-tab3"> +<div class="block">The aggregation modes for this Summary</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IntegerSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> </div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IntegerSummaryFactory.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Factory for IntegerSummary.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary + are performed.</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-tree.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-tree.html new file mode 100644 index 000000000..bce05d9e9 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-tree.html @@ -0,0 +1,102 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.aninteger Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.tuple.aninteger"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.tuple.aninteger</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="IntegerSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> (implements org.apache.datasketches.tuple.<a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>)</li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="IntegerSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a> (implements org.apache.datasketches.tuple.<a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="IntegerSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a> (implements org.apache.datasketches.tuple.<a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="IntegerSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a> (implements org.apache.datasketches.tuple.<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.<a href="../Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><S> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="../UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S> +<ul> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="IntegerSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="IntegerSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-use.html b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-use.html new file mode 100644 index 000000000..325bf6d33 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/aninteger/package-use.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.tuple.aninteger (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.aninteger"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.tuple.aninteger" class="title">Uses of Package<br>org.apache.datasketches.tuple.aninteger</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a> used by <a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/IntegerSummary.html#org.apache.datasketches.tuple.aninteger">IntegerSummary</a></div> +<div class="col-last even-row-color"> +<div class="block">Summary for generic tuple sketches of type Integer.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/IntegerSummary.Mode.html#org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></div> +<div class="col-last odd-row-color"> +<div class="block">The aggregation modes for this Summary</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html new file mode 100644 index 000000000..3c2d3192d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesAnotB (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesAnotB"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesAnotB.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesAnotB" class="title">Class ArrayOfDoublesAnotB</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotB</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ArrayOfDoublesAnotB</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Computes a set difference of two tuple sketches of type ArrayOfDoubles</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">update</a><wbr>(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> a, + <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> b)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Perform A-and-not-B set operation on the two given sketches.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> a, + <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> b)</span></div> +<div class="block">Perform A-and-not-B set operation on the two given sketches. + A null sketch is interpreted as an empty sketch. + This is not an accumulating update. Calling update() more than once + without calling getResult() will discard the result of previous update(). + Both input sketches must have the same <i>numValues</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - The incoming sketch for the first argument</dd> +<dd><code>b</code> - The incoming sketch for the second argument</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>compact sketch representing the result of the operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(org.apache.datasketches.memory.WritableMemory)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory mem)</span></div> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - memory for the result (can be null)</dd> +<dt>Returns:</dt> +<dd>compact sketch representing the result of the operation (off-heap if memory is + provided)</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html new file mode 100644 index 000000000..3ef4d35be --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html @@ -0,0 +1,207 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesAnotBImpl (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesAnotBImpl"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesAnotBImpl.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesAnotBImpl" class="title">Class ArrayOfDoublesAnotBImpl</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotB</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotBImpl</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfDoublesAnotBImpl</span> +<span class="extends-implements">extends <a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></span></div> +<div class="block">Computes a set difference, A-AND-NOT-B, of two ArrayOfDoublesSketches. + + <p>This class includes a stateless operation as follows:</p> + + <pre><code> + CompactSketch csk = anotb.aNotB(ArrayOfDoublesSketch skA, ArrayOfDoublesSketch skB); + </code></pre></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">update</a><wbr>(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skA, + <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skB)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Perform A-and-not-B set operation on the two given sketches.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skA, + <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skB)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfDoublesAnotB.html#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)">ArrayOfDoublesAnotB</a></code></span></div> +<div class="block">Perform A-and-not-B set operation on the two given sketches. + A null sketch is interpreted as an empty sketch. + This is not an accumulating update. Calling update() more than once + without calling getResult() will discard the result of previous update(). + Both input sketches must have the same <i>numValues</i>.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfDoublesAnotB.html#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)">update</a></code> in class <code><a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></code></dd> +<dt>Parameters:</dt> +<dd><code>skA</code> - The incoming sketch for the first argument</dd> +<dd><code>skB</code> - The incoming sketch for the second argument</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfDoublesAnotB.html#getResult()">ArrayOfDoublesAnotB</a></code></span></div> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfDoublesAnotB.html#getResult()">getResult</a></code> in class <code><a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></code></dd> +<dt>Returns:</dt> +<dd>compact sketch representing the result of the operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(org.apache.datasketches.memory.WritableMemory)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfDoublesAnotB.html#getResult(org.apache.datasketches.memory.WritableMemory)">ArrayOfDoublesAnotB</a></code></span></div> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfDoublesAnotB.html#getResult(org.apache.datasketches.memory.WritableMemory)">getResult</a></code> in class <code><a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></code></dd> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - memory for the result (can be null)</dd> +<dt>Returns:</dt> +<dd>compact sketch representing the result of the operation (off-heap if memory is + provided)</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html new file mode 100644 index 000000000..c5a826be7 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html @@ -0,0 +1,142 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesCombiner (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, interface: ArrayOfDoublesCombiner"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesCombiner.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Interface ArrayOfDoublesCombiner" class="title">Interface ArrayOfDoublesCombiner</h1> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ArrayOfDoublesCombiner</span></div> +<div class="block">Combines two arrays of double values for use with ArrayOfDoubles tuple sketches</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#combine(double%5B%5D,double%5B%5D)" class="member-name-link">combine</a><wbr>(double[] a, + double[] b)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Method of combining two arrays of double values</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="combine(double[],double[])"> +<h3>combine</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">combine</span><wbr><span class="parameters">(double[] a, + double[] b)</span></div> +<div class="block">Method of combining two arrays of double values</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>a</code> - Array A.</dd> +<dd><code>b</code> - Array B.</dd> +<dt>Returns:</dt> +<dd>Result of combining A and B</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html new file mode 100644 index 000000000..69298a040 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html @@ -0,0 +1,172 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesCompactSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesCompactSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesCompactSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesCompactSketch" class="title">Class ArrayOfDoublesCompactSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCompactSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ArrayOfDoublesCompactSketch</span> +<span class="extends-implements">extends <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span></div> +<div class="block">Top level compact tuple sketch of type ArrayOfDoubles. Compact sketches are never created + directly. They are created as a result of the compact() method on a QuickSelectSketch + or the getResult() method of a set operation like Union, Intersection or AnotB. + Compact sketch consists of a compact list (i.e. no intervening spaces) of hash values, + corresponding list of double values, and a value for theta. The lists may or may + not be ordered. A compact sketch is read-only.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentBytes()" class="member-name-link">getCurrentBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">For compact sketches this is the same as getMaxBytes().</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxBytes()" class="member-name-link">getMaxBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch">Methods inherited from class org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></h3> +<code><a href="ArrayOfDoublesSketch.html#compact()">compact</a>, <a href="ArrayOfDoublesSketch.html#compact(org.apache.datasketches.memory.WritableMemory)">compact</a>, <a href="ArrayOfDoublesSketch.html#getEstimate()">getEstimate</a>, <a href="ArrayOfDoublesSketch.html#getLowerBound(int)">getLowerBound</a>, <a href="ArrayOfDoublesSketch.html#getNumValues()">getNumValues</a>, <a href="ArrayOfDoublesSketch.html#getRetainedEntries()">getRetainedEntries</a>, <a href="ArrayOfDoublesSketch.html#getTheta()">getTheta</a>, <a href="ArrayOfDoublesSketch.html#getUpperBound(int)">getUpperBound</a>, <a href="ArrayOfDoublesSketch.html#getValues()">getValues</a>, <a href="ArrayOfDoublesSketch.html#hasMemory()">hasMemory</a>, <a href="ArrayOfDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)">heapify</a>, <a href="ArrayOfDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory,long)">heapify</a>, <a href="ArrayOfDoublesSketch.html#isEmpty()">isEmpty</a>, <a href="ArrayOfDoublesSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="ArrayOfDoublesSketch.html#iterator()">iterator</a>, <a href="ArrayOfDoublesSketch.html#toByteArray()">toByteArray</a>, <a href="ArrayOfDoublesSketch.html#toString()">toString</a>, <a href="ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a>, <a href="ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory,long)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getCurrentBytes()"> +<h3>getCurrentBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentBytes</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ArrayOfDoublesSketch.html#getCurrentBytes()">ArrayOfDoublesSketch</a></code></span></div> +<div class="block">For compact sketches this is the same as getMaxBytes().</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfDoublesSketch.html#getCurrentBytes()">getCurrentBytes</a></code> in class <code><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></dd> +<dt>Returns:</dt> +<dd>the current number of bytes for this sketch when serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxBytes()"> +<h3>getMaxBytes</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxBytes</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfDoublesSketch.html#getMaxBytes()">getMaxBytes</a></code> in class <code><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum number of bytes for this sketch when serialized.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html new file mode 100644 index 000000000..acf081b84 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html @@ -0,0 +1,197 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesIntersection (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesIntersection"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesIntersection.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesIntersection" class="title">Class ArrayOfDoublesIntersection</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesIntersection</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ArrayOfDoublesIntersection</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Computes the intersection of two or more tuple sketches of type ArrayOfDoubles. + A new instance represents the Universal Set. + Every update() computes an intersection with the internal set + and can only reduce the internal set.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the internal set as an on-heap compact sketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the result of stateful intersections so far.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersect(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner)" class="member-name-link">intersect</a><wbr>(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> tupleSketch, + <a href="ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a> combiner)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets the internal set to the initial state, which represents the Universal Set</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="intersect(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner)"> +<h3>intersect</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> tupleSketch, + <a href="ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a> combiner)</span></div> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch. + The given tupleSketch and the internal state must have the same <i>numValues</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketch</code> - Input sketch to intersect with the internal set.</dd> +<dd><code>combiner</code> - Method of combining two arrays of double values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Gets the internal set as an on-heap compact sketch.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>Result of the intersections so far as a compact sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(org.apache.datasketches.memory.WritableMemory)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Gets the result of stateful intersections so far.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - Memory for the compact sketch (can be null).</dd> +<dt>Returns:</dt> +<dd>Result of the intersections so far as a compact sketch.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets the internal set to the initial state, which represents the Universal Set</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html new file mode 100644 index 000000000..0b38a3f48 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html @@ -0,0 +1,370 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesSetOperationBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesSetOperationBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesSetOperationBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesSetOperationBuilder" class="title">Class ArrayOfDoublesSetOperationBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfDoublesSetOperationBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Builds set operations object for tuple sketches of type ArrayOfDoubles.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static final int</code></div> +<div class="col-second even-row-color"><code><a href="#DEFAULT_NOMINAL_ENTRIES" class="member-name-link">DEFAULT_NOMINAL_ENTRIES</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Default Nominal Entries (a.k.a.</div> +</div> +<div class="col-first odd-row-color"><code>static final int</code></div> +<div class="col-second odd-row-color"><code><a href="#DEFAULT_NUMBER_OF_VALUES" class="member-name-link">DEFAULT_NUMBER_OF_VALUES</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Default number of values</div> +</div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesSetOperationBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of the builder with default parameters</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildAnotB()" class="member-name-link">buildAnotB</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates an instance of ArrayOfDoublesAnotB based on the current configuration of the builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildIntersection()" class="member-name-link">buildIntersection</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildIntersection</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildUnion()" class="member-name-link">buildUnion</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder + and the given destination memory.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set the nominal number of entries.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumberOfValues(int)" class="member-name-link">setNumberOfValues</a><wbr>(int numValues)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set the number of double values associated with each key</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DEFAULT_NOMINAL_ENTRIES"> +<h3>DEFAULT_NOMINAL_ENTRIES</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_NOMINAL_ENTRIES</span></div> +<div class="block">Default Nominal Entries (a.k.a. K)</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../../constant-values.html#org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder.DEFAULT_NOMINAL_ENTRIES">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="DEFAULT_NUMBER_OF_VALUES"> +<h3>DEFAULT_NUMBER_OF_VALUES</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_NUMBER_OF_VALUES</span></div> +<div class="block">Default number of values</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../../constant-values.html#org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder.DEFAULT_NUMBER_OF_VALUES">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfDoublesSetOperationBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfDoublesSetOperationBuilder</span>()</div> +<div class="block">Creates an instance of the builder with default parameters</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setNominalEntries(int)"> +<h3>setNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></span> <span class="element-name">setNominalEntries</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">This is to set the nominal number of entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Nominal number of entries. Forced to the nearest power of 2 greater than + given value.</dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setNumberOfValues(int)"> +<h3>setNumberOfValues</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></span> <span class="element-name">setNumberOfValues</span><wbr><span class="parameters">(int numValues)</span></div> +<div class="block">This is to set the number of double values associated with each key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numValues</code> - number of double values</dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setSeed(long)"> +<h3>setSeed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></span> <span class="element-name">setSeed</span><wbr><span class="parameters">(long seed)</span></div> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seed</code> - <a href="../../../../../resources/dictionary.html#seed">See seed</a></dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildUnion()"> +<h3>buildUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">buildUnion</span>()</div> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder. + The new instance is allocated on the heap if the memory is not provided.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an instance of ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildUnion(org.apache.datasketches.memory.WritableMemory)"> +<h3>buildUnion</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">buildUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder + and the given destination memory.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - destination memory to be used by the sketch</dd> +<dt>Returns:</dt> +<dd>an instance of ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildIntersection()"> +<h3>buildIntersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></span> <span class="element-name">buildIntersection</span>()</div> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder. + The new instance is allocated on the heap if the memory is not provided. + The number of nominal entries is not relevant to this, so it is ignored.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an instance of ArrayOfDoublesIntersection</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildIntersection(org.apache.datasketches.memory.WritableMemory)"> +<h3>buildIntersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></span> <span class="element-name">buildIntersection</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder. + The new instance is allocated on the heap if the memory is not provided. + The number of nominal entries is not relevant to this, so it is ignored.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - destination memory to be used by the sketch</dd> +<dt>Returns:</dt> +<dd>an instance of ArrayOfDoublesIntersection</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildAnotB()"> +<h3>buildAnotB</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></span> <span class="element-name">buildAnotB</span>()</div> +<div class="block">Creates an instance of ArrayOfDoublesAnotB based on the current configuration of the builder. + The memory is not relevant to this, so it is ignored if set. + The number of nominal entries is not relevant to this, so it is ignored.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an instance of ArrayOfDoublesAnotB</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html new file mode 100644 index 000000000..5ebfe0a87 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html @@ -0,0 +1,467 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesSketch" class="title">Class ArrayOfDoublesSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code>, <code><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ArrayOfDoublesSketch</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values + is associated with each key. + A primitive array of doubles is used here, as opposed to a generic Summary object, + for improved performance.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCurrentBytes()" class="member-name-link">getCurrentBytes</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">For compact sketches this is the same as getMaxBytes().</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(int)" class="member-name-link">getLowerBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxBytes()" class="member-name-link">getMaxBytes</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumValues()" class="member-name-link">getNumValues</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTheta()" class="member-name-link">getTheta</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the value of theta as a double between zero and one</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound(int)" class="member-name-link">getUpperBound</a><wbr>(int numStdDev)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract double[][]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValues()" class="member-name-link">getValues</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasMemory()" class="member-name-link">hasMemory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block"><a href="../../../../../resources/dictionary.html#empty">See Empty</a></div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEstimationMode()" class="member-name-link">isEstimationMode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long seed)</span></div> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long seed)</span></div> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getEstimate()"> +<h3>getEstimate</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getEstimate</span>()</div> +<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>best estimate of the number of unique values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getUpperBound(int)"> +<h3>getUpperBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getUpperBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the upper bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLowerBound(int)"> +<h3>getLowerBound</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(int numStdDev)</span></div> +<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations. + This will return getEstimate() if isEmpty() is true.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numStdDev</code> - <a href="../../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> +<dt>Returns:</dt> +<dd>the lower bound.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hasMemory()"> +<h3>hasMemory</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">hasMemory</span>()</div> +<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEmpty()"> +<h3>isEmpty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> +<div class="block"><a href="../../../../../resources/dictionary.html#empty">See Empty</a></div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if empty.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNumValues()"> +<h3>getNumValues</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumValues</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>number of double values associated with each key</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isEstimationMode()"> +<h3>isEstimationMode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEstimationMode</span>()</div> +<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode). + This is true if theta < 1.0 AND isEmpty() is false.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the sketch is in estimation mode.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getTheta()"> +<h3>getTheta</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getTheta</span>()</div> +<div class="block">Gets the value of theta as a double between zero and one</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the value of theta as a double</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxBytes()"> +<h3>getMaxBytes</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getMaxBytes</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the maximum number of bytes for this sketch when serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentBytes()"> +<h3>getCurrentBytes</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getCurrentBytes</span>()</div> +<div class="block">For compact sketches this is the same as getMaxBytes().</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the current number of bytes for this sketch when serialized.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>serialized representation of the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getValues()"> +<h3>getValues</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">double[][]</span> <span class="element-name">getValues</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>array of arrays of double values in the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></span> <span class="element-name">iterator</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>iterator over the sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">compact</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>this sketch in compact form, which is immutable.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact(org.apache.datasketches.memory.WritableMemory)"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">compact</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - the destination WritableMemory</dd> +<dt>Returns:</dt> +<dd>this sketch in compact form, which is immutable.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toString()"> +<h3>toString</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html new file mode 100644 index 000000000..ccfc22248 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html @@ -0,0 +1,178 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, interface: ArrayOfDoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesSketchIterator.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Interface ArrayOfDoublesSketchIterator" class="title">Interface ArrayOfDoublesSketchIterator</h1> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ArrayOfDoublesSketchIterator</span></div> +<div class="block">Interface for iterating over tuple sketches of type ArrayOfDoubles</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getKey()" class="member-name-link">getKey</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets a key from the current entry in the sketch, which is a hash + of the original key passed to update().</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValues()" class="member-name-link">getValues</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets an array of values from the current entry in the sketch.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#next()" class="member-name-link">next</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Advancing the iterator and checking existence of the next entry + is combined here for efficiency.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="next()"> +<h3>next</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">next</span>()</div> +<div class="block">Advancing the iterator and checking existence of the next entry + is combined here for efficiency. This results in an undefined + state of the iterator before the first call of this method.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if the next element exists</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getKey()"> +<h3>getKey</h3> +<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getKey</span>()</div> +<div class="block">Gets a key from the current entry in the sketch, which is a hash + of the original key passed to update(). The original keys are not + retained. Don't call this before calling next() for the first time + or after getting false from next().</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>hash key from the current entry</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getValues()"> +<h3>getValues</h3> +<div class="member-signature"><span class="return-type">double[]</span> <span class="element-name">getValues</span>()</div> +<div class="block">Gets an array of values from the current entry in the sketch. + Don't call this before calling next() for the first time + or after getting false from next().</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>array of double values for the current entry (may or may not be a copy)</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html new file mode 100644 index 000000000..5c6941f05 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html @@ -0,0 +1,428 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesSketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesSketches"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesSketches.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesSketches" class="title">Class ArrayOfDoublesSketches</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketches</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ArrayOfDoublesSketches</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Convenient static methods to instantiate tuple sketches of type ArrayOfDoubles.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesSketches</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifySketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifySketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyUnion(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUnion(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUnion(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUpdatableSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUpdatableSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfDoublesSketches</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfDoublesSketches</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapifySketch(org.apache.datasketches.memory.Memory)"> +<h3>heapifySketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">heapifySketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifySketch(org.apache.datasketches.memory.Memory,long)"> +<h3>heapifySketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">heapifySketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long seed)</span></div> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyUpdatableSketch(org.apache.datasketches.memory.Memory)"> +<h3>heapifyUpdatableSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">heapifyUpdatableSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,long)"> +<h3>heapifyUpdatableSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">heapifyUpdatableSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long seed)</span></div> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSketch(org.apache.datasketches.memory.Memory)"> +<h3>wrapSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">wrapSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapSketch(org.apache.datasketches.memory.Memory,long)"> +<h3>wrapSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span> <span class="element-name">wrapSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long seed)</span></div> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrapUpdatableSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">wrapUpdatableSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrapUpdatableSketch</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">wrapUpdatableSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</span></div> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyUnion(org.apache.datasketches.memory.Memory)"> +<h3>heapifyUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">heapifyUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapifyUnion(org.apache.datasketches.memory.Memory,long)"> +<h3>heapifyUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">heapifyUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long seed)</span></div> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUnion(org.apache.datasketches.memory.Memory)"> +<h3>wrapUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrapUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUnion(org.apache.datasketches.memory.Memory,long)"> +<h3>wrapUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrapUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long seed)</span></div> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUnion(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrapUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrapUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrapUnion(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrapUnion</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrapUnion</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</span></div> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html new file mode 100644 index 000000000..e715ab785 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html @@ -0,0 +1,342 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesUnion"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesUnion.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesUnion" class="title">Class ArrayOfDoublesUnion</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUnion</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ArrayOfDoublesUnion</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The base class for unions of tuple sketches of type ArrayOfDoubles.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxBytes(int,int)" class="member-name-link">getMaxBytes</a><wbr>(int nomEntries, + int numValues)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets the union to an empty state</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">union</a><wbr>(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> tupleSketch)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the union by adding a set of entries from a given sketch, which can be on-heap or off-heap.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given WritableMemory and seed as an ArrayOfDoublesUnion</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long seed)</span></div> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem)</span></div> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.Memory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory srcMem, + long seed)</span></div> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem)</span></div> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</span></div> +<div class="block">Wrap the given WritableMemory and seed as an ArrayOfDoublesUnion</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>srcMem</code> - the given source Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUnion</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="union(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> tupleSketch)</span></div> +<div class="block">Updates the union by adding a set of entries from a given sketch, which can be on-heap or off-heap. + Both the given tupleSketch and the internal state of the Union must have the same <i>numValues</i>. + + <p>Nulls and empty sketches are ignored.</p></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>tupleSketch</code> - sketch to add to the union</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult(org.apache.datasketches.memory.WritableMemory)"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - memory for the result (can be null)</dd> +<dt>Returns:</dt> +<dd>compact sketch representing the union (off-heap if memory is provided)</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResult()"> +<h3>getResult</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">getResult</span>()</div> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>on-heap compact sketch representing the union</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets the union to an empty state</div> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>a byte array representation of this object</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getMaxBytes(int,int)"> +<h3>getMaxBytes</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getMaxBytes</span><wbr><span class="parameters">(int nomEntries, + int numValues)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Nominal number of entries. Forced to the nearest power of 2 greater than or equal to + given value.</dd> +<dd><code>numValues</code> - Number of double values to keep for each key</dd> +<dt>Returns:</dt> +<dd>maximum required storage bytes given nomEntries and numValues</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html new file mode 100644 index 000000000..bc4ca24f6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html @@ -0,0 +1,461 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesUpdatableSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesUpdatableSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesUpdatableSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesUpdatableSketch" class="title">Class ArrayOfDoublesUpdatableSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketch</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ArrayOfDoublesUpdatableSketch</span> +<span class="extends-implements">extends <a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span></div> +<div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an on-heap compact representation of the sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets an off-heap compact representation of the sketch using the given memory</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNominalEntries()" class="member-name-link">getNominalEntries</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the configured nominal number of entries</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the configured resize factor</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSamplingProbability()" class="member-name-link">getSamplingProbability</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Gets the configured sampling probability</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Resets this sketch an empty state.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#trim()" class="member-name-link">trim</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(byte%5B%5D,double%5B%5D)" class="member-name-link">update</a><wbr>(byte[] key, + double[] values)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a byte[] key and double values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(double,double%5B%5D)" class="member-name-link">update</a><wbr>(double key, + double[] values)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a double key and double values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(int%5B%5D,double%5B%5D)" class="member-name-link">update</a><wbr>(int[] key, + double[] values)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a int[] key and double values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long%5B%5D,double%5B%5D)" class="member-name-link">update</a><wbr>(long[] key, + double[] values)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a long[] key and double values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(long,double%5B%5D)" class="member-name-link">update</a><wbr>(long key, + double[] values)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a long key and double values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String,double%5B%5D)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + double[] values)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a String key and double values.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.nio.ByteBuffer,double%5B%5D)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> key, + double[] values)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates this sketch with a ByteBuffer key and double values.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory mem, + long seed)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch">Methods inherited from class org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></h3> +<code><a href="ArrayOfDoublesSketch.html#getCurrentBytes()">getCurrentBytes</a>, <a href="ArrayOfDoublesSketch.html#getEstimate()">getEstimate</a>, <a href="ArrayOfDoublesSketch.html#getLowerBound(int)">getLowerBound</a>, <a href="ArrayOfDoublesSketch.html#getMaxBytes()">getMaxBytes</a>, <a href="ArrayOfDoublesSketch.html#getNumValues()">getNumValues</a>, <a href="ArrayOfDoublesSketch.html#getRetainedEntries()">getRetainedEntries</a>, <a href="ArrayOfDoublesSketch.html#getTheta()">getTheta</a>, <a href="ArrayOfDoublesSketch.html#getUpperBound(int)">getUpperBound</a>, <a href="ArrayOfDoublesSketch.html#getValues()">getValues</a>, <a href="ArrayOfDoublesSketch.html#hasMemory()">hasMemory</a>, <a href="ArrayOfDoublesSketch.html#isEmpty()">isEmpty</a>, <a href="ArrayOfDoublesSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="ArrayOfDoublesSketch.html#iterator()">iterator</a>, <a href="ArrayOfDoublesSketch.html#toByteArray()">toByteArray</a>, <a href="ArrayOfDoublesSketch.html#toString()">toString</a>, <a href="ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a>, <a href="ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory,long)">wrap</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="heapify(org.apache.datasketches.memory.Memory,long)"> +<h3>heapify</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">heapify</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem, + long seed)</span></div> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory mem)</span></div> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="wrap(org.apache.datasketches.memory.WritableMemory,long)"> +<h3>wrap</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">wrap</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory mem, + long seed)</span></div> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +<dd><code>seed</code> - the given seed</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long,double[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long key, + double[] values)</span></div> +<div class="block">Updates this sketch with a long key and double values. + The values will be stored or added to the ones associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given long key</dd> +<dd><code>values</code> - The given values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(double,double[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(double key, + double[] values)</span></div> +<div class="block">Updates this sketch with a double key and double values. + The values will be stored or added to the ones associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given double key</dd> +<dd><code>values</code> - The given values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String,double[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, + double[] values)</span></div> +<div class="block">Updates this sketch with a String key and double values. + The values will be stored or added to the ones associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given String key</dd> +<dd><code>values</code> - The given values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(byte[],double[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(byte[] key, + double[] values)</span></div> +<div class="block">Updates this sketch with a byte[] key and double values. + The values will be stored or added to the ones associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given byte[] key</dd> +<dd><code>values</code> - The given values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.nio.ByteBuffer,double[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> key, + double[] values)</span></div> +<div class="block">Updates this sketch with a ByteBuffer key and double values. + The values will be stored or added to the ones associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given ByteBuffer key</dd> +<dd><code>values</code> - The given values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(int[],double[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(int[] key, + double[] values)</span></div> +<div class="block">Updates this sketch with a int[] key and double values. + The values will be stored or added to the ones associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given int[] key</dd> +<dd><code>values</code> - The given values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(long[],double[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(long[] key, + double[] values)</span></div> +<div class="block">Updates this sketch with a long[] key and double values. + The values will be stored or added to the ones associated with the key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>key</code> - The given long[] key</dd> +<dd><code>values</code> - The given values</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNominalEntries()"> +<h3>getNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getNominalEntries</span>()</div> +<div class="block">Gets the configured nominal number of entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>nominal number of entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Gets the configured resize factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>resize factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamplingProbability()"> +<h3>getSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">float</span> <span class="element-name">getSamplingProbability</span>()</div> +<div class="block">Gets the configured sampling probability</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>sampling probability</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="trim()"> +<h3>trim</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">trim</span>()</div> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch an empty state.</div> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">compact</span>()</div> +<div class="block">Gets an on-heap compact representation of the sketch</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="ArrayOfDoublesSketch.html#compact()">compact</a></code> in class <code><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></dd> +<dt>Returns:</dt> +<dd>compact sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="compact(org.apache.datasketches.memory.WritableMemory)"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span> <span class="element-name">compact</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Gets an off-heap compact representation of the sketch using the given memory</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="ArrayOfDoublesSketch.html#compact(org.apache.datasketches.memory.WritableMemory)">compact</a></code> in class <code><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></dd> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - memory for the compact sketch (can be null)</dd> +<dt>Returns:</dt> +<dd>compact sketch (off-heap if memory is provided)</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html new file mode 100644 index 000000000..ff28c2de5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html @@ -0,0 +1,286 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfDoublesUpdatableSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesUpdatableSketchBuilder"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfDoublesUpdatableSketchBuilder.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<h1 title="Class ArrayOfDoublesUpdatableSketchBuilder" class="title">Class ArrayOfDoublesUpdatableSketchBuilder</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketchBuilder</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfDoublesUpdatableSketchBuilder</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">For building a new ArrayOfDoublesUpdatableSketch</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfDoublesUpdatableSketchBuilder</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of builder with default parameters</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set the nominal number of entries.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumberOfValues(int)" class="member-name-link">setNumberOfValues</a><wbr>(int numValues)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set the number of double values associated with each key</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set the resize factor.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSamplingProbability(float)" class="member-name-link">setSamplingProbability</a><wbr>(float samplingProbability)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to set sampling probability.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfDoublesUpdatableSketchBuilder</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfDoublesUpdatableSketchBuilder</span>()</div> +<div class="block">Creates an instance of builder with default parameters</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="setNominalEntries(int)"> +<h3>setNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></span> <span class="element-name">setNominalEntries</span><wbr><span class="parameters">(int nomEntries)</span></div> +<div class="block">This is to set the nominal number of entries.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>nomEntries</code> - Nominal number of entries. Forced to the nearest power of 2 greater than + or equal to given value.</dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setResizeFactor(org.apache.datasketches.common.ResizeFactor)"> +<h3>setResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></span> <span class="element-name">setResizeFactor</span><wbr><span class="parameters">(<a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</span></div> +<div class="block">This is to set the resize factor. + Value of X1 means that the maximum capacity is allocated from the start. + Default resize factor is X8.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>resizeFactor</code> - value of X1, X2, X4 or X8</dd> +<dt>Returns:</dt> +<dd>this UpdatableSketchBuilder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setSamplingProbability(float)"> +<h3>setSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></span> <span class="element-name">setSamplingProbability</span><wbr><span class="parameters">(float samplingProbability)</span></div> +<div class="block">This is to set sampling probability. + Default probability is 1.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>samplingProbability</code> - sampling probability from 0 to 1</dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setNumberOfValues(int)"> +<h3>setNumberOfValues</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></span> <span class="element-name">setNumberOfValues</span><wbr><span class="parameters">(int numValues)</span></div> +<div class="block">This is to set the number of double values associated with each key</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>numValues</code> - number of double values</dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setSeed(long)"> +<h3>setSeed</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></span> <span class="element-name">setSeed</span><wbr><span class="parameters">(long seed)</span></div> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>seed</code> - <a href="../../../../../resources/dictionary.html#seed">See seed</a></dd> +<dt>Returns:</dt> +<dd>this builder</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build()"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">build</span>()</div> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="build(org.apache.datasketches.memory.WritableMemory)"> +<h3>build</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span> <span class="element-name">build</span><wbr><span class="parameters">(org.apache.datasketches.memory.WritableMemory dstMem)</span></div> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dstMem</code> - instance of Memory to be used by the sketch</dd> +<dt>Returns:</dt> +<dd>an ArrayOfDoublesUpdatableSketch</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesAnotB.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesAnotB.html new file mode 100644 index 000000000..d2e712cd8 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesAnotB.html @@ -0,0 +1,102 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotB (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesAnotB"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotB" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotB</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Subclasses of <a href="../ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ArrayOfDoublesAnotBImpl.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two ArrayOfDoublesSketches.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#buildAnotB()" class="member-name-link">buildAnotB</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of ArrayOfDoublesAnotB based on the current configuration of the builder.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesAnotBImpl.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesAnotBImpl.html new file mode 100644 index 000000000..45e008807 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesAnotBImpl.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotBImpl (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesAnotBImpl"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotBImpl" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotBImpl</h1> +</div> +No usage of org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesAnotBImpl</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesCombiner.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesCombiner.html new file mode 100644 index 000000000..bd05157cf --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesCombiner.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, interface: ArrayOfDoublesCombiner"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner" class="title">Uses of Interface<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> with parameters of type <a href="../ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesIntersection.</span><code><a href="../ArrayOfDoublesIntersection.html#intersect(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner)" class="member-name-link">intersect</a><wbr>(<a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> tupleSketch, + <a href="../ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a> combiner)</code></div> +<div class="col-last even-row-color"> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesCompactSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesCompactSketch.html new file mode 100644 index 000000000..0fe66c5bb --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesCompactSketch.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCompactSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesCompactSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCompactSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCompactSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketch.</span><code><a href="../ArrayOfDoublesSketch.html#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>abstract <a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketch.</span><code><a href="../ArrayOfDoublesSketch.html#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketch.</span><code><a href="../ArrayOfDoublesUpdatableSketch.html#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets an on-heap compact representation of the sketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketch.</span><code><a href="../ArrayOfDoublesUpdatableSketch.html#compact(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">compact</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets an off-heap compact representation of the sketch using the given memory</div> +</div> +<div class="col-first even-row-color"><code>abstract <a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesAnotB.</span><code><a href="../ArrayOfDoublesAnotB.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</div> +<div class="col-first odd-row-color"><code>abstract <a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesAnotB.</span><code><a href="../ArrayOfDoublesAnotB.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of this operation in the form of a ArrayOfDoublesCompactSketch</div> +</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesAnotBImpl.</span><code><a href="../ArrayOfDoublesAnotBImpl.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesAnotBImpl.</span><code><a href="../ArrayOfDoublesAnotBImpl.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesIntersection.</span><code><a href="../ArrayOfDoublesIntersection.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the internal set as an on-heap compact sketch.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesIntersection.</span><code><a href="../ArrayOfDoublesIntersection.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of stateful intersections so far.</div> +</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#getResult(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">getResult</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the resulting union in the form of a compact sketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesIntersection.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesIntersection.html new file mode 100644 index 000000000..c4af4c7ca --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesIntersection.html @@ -0,0 +1,98 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesIntersection (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesIntersection"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesIntersection" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesIntersection</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#buildIntersection()" class="member-name-link">buildIntersection</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#buildIntersection(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildIntersection</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an instance of ArrayOfDoublesIntersection based on the current configuration of the + builder.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSetOperationBuilder.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSetOperationBuilder.html new file mode 100644 index 000000000..b33c52362 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSetOperationBuilder.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesSetOperationBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSetOperationBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to set the nominal number of entries.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#setNumberOfValues(int)" class="member-name-link">setNumberOfValues</a><wbr>(int numValues)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This is to set the number of double values associated with each key</div> +</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketch.html new file mode 100644 index 000000000..ab0c6162d --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketch.html @@ -0,0 +1,173 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Subclasses of <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../ArrayOfDoublesCompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Top level compact tuple sketch of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../ArrayOfDoublesUpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketch.</span><code><a href="../ArrayOfDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketch.</span><code><a href="../ArrayOfDoublesSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#heapifySketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#heapifySketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketch.</span><code><a href="../ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketch.</span><code><a href="../ArrayOfDoublesSketch.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> with parameters of type <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesIntersection.</span><code><a href="../ArrayOfDoublesIntersection.html#intersect(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesCombiner)" class="member-name-link">intersect</a><wbr>(<a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> tupleSketch, + <a href="../ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a> combiner)</code></div> +<div class="col-last even-row-color"> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#union(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">union</a><wbr>(<a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> tupleSketch)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Updates the union by adding a set of entries from a given sketch, which can be on-heap or off-heap.</div> +</div> +<div class="col-first even-row-color"><code>abstract void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesAnotB.</span><code><a href="../ArrayOfDoublesAnotB.html#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">update</a><wbr>(<a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> a, + <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> b)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform A-and-not-B set operation on the two given sketches.</div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesAnotBImpl.</span><code><a href="../ArrayOfDoublesAnotBImpl.html#update(org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch,org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch)" class="member-name-link">update</a><wbr>(<a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skA, + <a href="../ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> skB)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketchIterator.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketchIterator.html new file mode 100644 index 000000000..dc1350d2f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketchIterator.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, interface: ArrayOfDoublesSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketchIterator" class="title">Uses of Interface<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>abstract <a href="../ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketch.</span><code><a href="../ArrayOfDoublesSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketches.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketches.html new file mode 100644 index 000000000..3f8da576b --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesSketches.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesSketches"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketches" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketches</h1> +</div> +No usage of org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketches</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUnion.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUnion.html new file mode 100644 index 000000000..27f210415 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUnion.html @@ -0,0 +1,163 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUnion (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesUnion"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUnion" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUnion</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#buildUnion()" class="member-name-link">buildUnion</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSetOperationBuilder.</span><code><a href="../ArrayOfDoublesSetOperationBuilder.html#buildUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">buildUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates an instance of ArrayOfDoublesUnion based on the current configuration of the builder + and the given destination memory.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#heapifyUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#heapifyUnion(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUnion.</span><code><a href="../ArrayOfDoublesUnion.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given WritableMemory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.Memory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.Memory,long)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given Memory as an ArrayOfDoublesUnion</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapUnion(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUnion</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given Memory and seed as an ArrayOfDoublesUnion</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUpdatableSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUpdatableSketch.html new file mode 100644 index 000000000..2da9842d3 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUpdatableSketch.html @@ -0,0 +1,140 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesUpdatableSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html#build(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">build</a><wbr>(org.apache.datasketches.memory.WritableMemory dstMem)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an ArrayOfDoublesUpdatableSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketch.</span><code><a href="../ArrayOfDoublesUpdatableSketch.html#heapify(org.apache.datasketches.memory.Memory)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketch.</span><code><a href="../ArrayOfDoublesUpdatableSketch.html#heapify(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory mem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Heapify the given Memory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,long)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Heapify the given Memory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketch.</span><code><a href="../ArrayOfDoublesUpdatableSketch.html#wrap(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketch.</span><code><a href="../ArrayOfDoublesUpdatableSketch.html#wrap(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.WritableMemory mem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory)" class="member-name-link">wrapUpdatableSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Wrap the given WritableMemory as an ArrayOfDoublesUpdatableSketch</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesSketches.</span><code><a href="../ArrayOfDoublesSketches.html#wrapUpdatableSketch(org.apache.datasketches.memory.WritableMemory,long)" class="member-name-link">wrapUpdatableSketch</a><wbr>(org.apache.datasketches.memory.WritableMemory srcMem, + long seed)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Wrap the given WritableMemory and seed as a ArrayOfDoublesUpdatableSketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUpdatableSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUpdatableSketchBuilder.html new file mode 100644 index 000000000..edc87b932 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/class-use/ArrayOfDoublesUpdatableSketchBuilder.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles, class: ArrayOfDoublesUpdatableSketchBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketchBuilder" class="title">Uses of Class<br>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesUpdatableSketchBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<h2>Uses of <a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> that return <a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to set the nominal number of entries.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html#setNumberOfValues(int)" class="member-name-link">setNumberOfValues</a><wbr>(int numValues)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This is to set the number of double values associated with each key</div> +</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to set the resize factor.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html#setSamplingProbability(float)" class="member-name-link">setSamplingProbability</a><wbr>(float samplingProbability)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This is to set sampling probability.</div> +</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfDoublesUpdatableSketchBuilder.</span><code><a href="../ArrayOfDoublesUpdatableSketchBuilder.html#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long seed)</code></div> +<div class="col-last even-row-color"> +<div class="block">Sets the long seed value that is required by the hashing function.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-summary.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-summary.html new file mode 100644 index 000000000..be39782a6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-summary.html @@ -0,0 +1,170 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.arrayofdoubles (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.arrayofdoubles"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.tuple.arrayofdoubles" class="title">Package org.apache.datasketches.tuple.arrayofdoubles</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.tuple.arrayofdoubles</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Computes a set difference of two tuple sketches of type ArrayOfDoubles</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two ArrayOfDoublesSketches.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">Combines two arrays of double values for use with ArrayOfDoubles tuple sketches</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Top level compact tuple sketch of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Computes the intersection of two or more tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Builds set operations object for tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values + is associated with each key.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Convenient static methods to instantiate tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">Interface for iterating over tuple sketches of type ArrayOfDoubles</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">The base class for unions of tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">For building a new ArrayOfDoublesUpdatableSketch</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-tree.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-tree.html new file mode 100644 index 000000000..5995b316e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-tree.html @@ -0,0 +1,98 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.arrayofdoubles Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.tuple.arrayofdoubles"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.tuple.arrayofdoubles</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesAnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesAnotBImpl.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesIntersection.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesSetOperationBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesCompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesUpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesSketches.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesUnion.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesUpdatableSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesCombiner.html" class="type-name-link" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="ArrayOfDoublesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-use.html b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-use.html new file mode 100644 index 000000000..e6886c603 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/arrayofdoubles/package-use.html @@ -0,0 +1,125 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.tuple.arrayofdoubles (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.arrayofdoubles"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.tuple.arrayofdoubles" class="title">Uses of Package<br>org.apache.datasketches.tuple.arrayofdoubles</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.arrayofdoubles"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a> used by <a href="package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfDoublesAnotB.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></div> +<div class="col-last even-row-color"> +<div class="block">Computes a set difference of two tuple sketches of type ArrayOfDoubles</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ArrayOfDoublesCombiner.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></div> +<div class="col-last odd-row-color"> +<div class="block">Combines two arrays of double values for use with ArrayOfDoubles tuple sketches</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfDoublesCompactSketch.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">Top level compact tuple sketch of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ArrayOfDoublesIntersection.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></div> +<div class="col-last odd-row-color"> +<div class="block">Computes the intersection of two or more tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfDoublesSetOperationBuilder.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></div> +<div class="col-last even-row-color"> +<div class="block">Builds set operations object for tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ArrayOfDoublesSketch.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values + is associated with each key.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfDoublesSketchIterator.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for iterating over tuple sketches of type ArrayOfDoubles</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ArrayOfDoublesUnion.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></div> +<div class="col-last odd-row-color"> +<div class="block">The base class for unions of tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfDoublesUpdatableSketch.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/ArrayOfDoublesUpdatableSketchBuilder.html#org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></div> +<div class="col-last odd-row-color"> +<div class="block">For building a new ArrayOfDoublesUpdatableSketch</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/AnotB.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/AnotB.html new file mode 100644 index 000000000..072ae7d86 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/AnotB.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.AnotB (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: AnotB"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../AnotB.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.AnotB" class="title">Uses of Class<br>org.apache.datasketches.tuple.AnotB</h1> +</div> +No usage of org.apache.datasketches.tuple.AnotB</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/CompactSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/CompactSketch.html new file mode 100644 index 000000000..16d80d561 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/CompactSketch.html @@ -0,0 +1,163 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.CompactSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: CompactSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.CompactSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.CompactSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../CompactSketch.html" title="type parameter in CompactSketch">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Sketch.html" title="type parameter in Sketch">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Converts this sketch to a CompactSketch on the Java heap.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Filter.html" title="type parameter in Filter">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Filter.</span><code><a href="../Filter.html#filter(org.apache.datasketches.tuple.Sketch)" class="member-name-link">filter</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Filter.html" title="type parameter in Filter">T</a>> sketchIn)</code></div> +<div class="col-last even-row-color"> +<div class="block">Filters elements on the provided <a href="../Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a></div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../AnotB.html" title="type parameter in AnotB">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#getResult(boolean)" class="member-name-link">getResult</a><wbr>(boolean reset)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls + to <a href="../AnotB.html#setA(org.apache.datasketches.tuple.Sketch)"><code>AnotB.setA(Sketch)</code></a> and (<a href="../AnotB.html#notB(org.apache.datasketches.tuple.Sketch)"><code>AnotB.notB(Sketch)</code></a> or + <a href="../AnotB.html#notB(org.apache.datasketches.theta.Sketch)"><code>AnotB.notB(org.apache.datasketches.theta.Sketch)</code></a>).</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the internal set as an unordered CompactSketch</div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getResult()" class="member-name-link">getResult</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#getResult(boolean)" class="member-name-link">getResult</a><wbr>(boolean reset)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../Intersection.html" title="type parameter in Intersection">S</a> summary)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the + result as an unordered CompactSketch on the heap.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform a stateless intersect set operation on the two given tuple sketches and returns the + result as an unordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Union.html" title="type parameter in Union">S</a>> tupleSketch, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../Union.html" title="type parameter in Union">S</a> summary)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Union.html" title="type parameter in Union">S</a>> tupleSketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Union.html" title="type parameter in Union">S</a>> tupleSketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform a stateless, pair-wise union operation between two tuple sketches.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/DeserializeResult.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/DeserializeResult.html new file mode 100644 index 000000000..a931dd118 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/DeserializeResult.html @@ -0,0 +1,157 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.DeserializeResult (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: DeserializeResult"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.DeserializeResult" class="title">Uses of Class<br>org.apache.datasketches.tuple.DeserializeResult</h1> +</div> +<div class="caption"><span>Packages that use <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../SummaryDeserializer.html" title="type parameter in SummaryDeserializer">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SummaryDeserializer.</span><code><a href="../SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to create an instance of a Summary given a serialized representation.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Methods in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that return <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">DoubleSummary.</span><code><a href="../adouble/DoubleSummary.html#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of the DoubleSummary given a serialized representation</div> +</div> +<div class="col-first odd-row-color"><code><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">DoubleSummaryDeserializer.</span><code><a href="../adouble/DoubleSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Methods in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that return <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">IntegerSummary.</span><code><a href="../aninteger/IntegerSummary.html#fromMemory(org.apache.datasketches.memory.Memory)" class="member-name-link">fromMemory</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of the IntegerSummary given a serialized representation</div> +</div> +<div class="col-first odd-row-color"><code><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">IntegerSummaryDeserializer.</span><code><a href="../aninteger/IntegerSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Methods in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that return <a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfStringsSummaryDeserializer.</span><code><a href="../strings/ArrayOfStringsSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/Filter.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Filter.html new file mode 100644 index 000000000..2b975fd97 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Filter.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.Filter (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: Filter"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Filter.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.Filter" class="title">Uses of Class<br>org.apache.datasketches.tuple.Filter</h1> +</div> +No usage of org.apache.datasketches.tuple.Filter</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/Intersection.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Intersection.html new file mode 100644 index 000000000..8141bf3f6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Intersection.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.Intersection (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: Intersection"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Intersection.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.Intersection" class="title">Uses of Class<br>org.apache.datasketches.tuple.Intersection</h1> +</div> +No usage of org.apache.datasketches.tuple.Intersection</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/JaccardSimilarity.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/JaccardSimilarity.html new file mode 100644 index 000000000..5a9726225 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/JaccardSimilarity.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.JaccardSimilarity (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: JaccardSimilarity"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.JaccardSimilarity" class="title">Uses of Class<br>org.apache.datasketches.tuple.JaccardSimilarity</h1> +</div> +No usage of org.apache.datasketches.tuple.JaccardSimilarity</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/SerializerDeserializer.SketchType.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SerializerDeserializer.SketchType.html new file mode 100644 index 000000000..79a4973a2 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SerializerDeserializer.SketchType.html @@ -0,0 +1,116 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Enum Class org.apache.datasketches.tuple.SerializerDeserializer.SketchType (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: SerializerDeserializer, enum: SketchType"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Enum Class org.apache.datasketches.tuple.SerializerDeserializer.SketchType" class="title">Uses of Enum Class<br>org.apache.datasketches.tuple.SerializerDeserializer.SketchType</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">SerializerDeserializer.</span><code><a href="../SerializerDeserializer.html#getSketchType(org.apache.datasketches.memory.Memory)" class="member-name-link">getSketchType</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the sketch type byte from the given Memory image</div> +</div> +<div class="col-first odd-row-color"><code>static <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">SerializerDeserializer.SketchType.</span><code><a href="../SerializerDeserializer.SketchType.html#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the enum constant of this class with the specified name.</div> +</div> +<div class="col-first even-row-color"><code>static <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a>[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">SerializerDeserializer.SketchType.</span><code><a href="../SerializerDeserializer.SketchType.html#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an array containing the constants of this enum class, in +the order they are declared.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">SerializerDeserializer.</span><code><a href="../SerializerDeserializer.html#validateType(byte,org.apache.datasketches.tuple.SerializerDeserializer.SketchType)" class="member-name-link">validateType</a><wbr>(byte sketchTypeByte, + <a href="../SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a> expectedType)</code></div> +<div class="col-last even-row-color"> +<div class="block">Validates the sketch type byte versus the expected value</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/SerializerDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SerializerDeserializer.html new file mode 100644 index 000000000..08db3bc36 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SerializerDeserializer.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.SerializerDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: SerializerDeserializer"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.SerializerDeserializer" class="title">Uses of Class<br>org.apache.datasketches.tuple.SerializerDeserializer</h1> +</div> +No usage of org.apache.datasketches.tuple.SerializerDeserializer</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/Sketch.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Sketch.html new file mode 100644 index 000000000..1b1f5e22e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Sketch.html @@ -0,0 +1,378 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.Sketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: Sketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.Sketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.Sketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../../fdt/package-summary.html">org.apache.datasketches.fdt</a></h2> +<div class="caption"><span>Subclasses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../../fdt/package-summary.html">org.apache.datasketches.fdt</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../fdt/FdtSketch.html" class="type-name-link" title="class in org.apache.datasketches.fdt">FdtSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A Frequent Distinct Tuples sketch.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></h2> +<div class="caption"><span>Methods in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Subclasses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">CompactSketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">CompactSketches are never created directly.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S extends <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></code></div> +<div class="col-last odd-row-color"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#createEmptySketch()" class="member-name-link">createEmptySketch</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Instantiate a Sketch from a given Memory.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Filter.html" title="type parameter in Filter">T</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Filter.</span><code><a href="../Filter.html#filter(org.apache.datasketches.tuple.Sketch)" class="member-name-link">filter</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Filter.html" title="type parameter in Filter">T</a>> sketchIn)</code></div> +<div class="col-last even-row-color"> +<div class="block">Filters elements on the provided <a href="../Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a></div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.tuple.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Performs a stateful intersection of the internal set with the given tupleSketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../Intersection.html" title="type parameter in Intersection">S</a> summary)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the + result as an unordered CompactSketch on the heap.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Intersection.</span><code><a href="../Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">intersect</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> tupleSketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform a stateless intersect set operation on the two given tuple sketches and returns the + result as an unordered CompactSketch on the heap.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#notB(org.apache.datasketches.tuple.Sketch)" class="member-name-link">notB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../AnotB.html" title="type parameter in AnotB">S</a>> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first odd-row-color"><code>void</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#setA(org.apache.datasketches.tuple.Sketch)" class="member-name-link">setA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../AnotB.html" title="type parameter in AnotB">S</a>> skA)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the + first argument <i>A</i> of <i>A-AND-NOT-B</i>.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first even-row-color"><code>void</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.tuple.Sketch)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Union.html" title="type parameter in Union">S</a>> tupleSketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Performs a stateful union of the internal set with the given tupleSketch.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Union.html" title="type parameter in Union">S</a>> tupleSketch, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, + <a href="../Union.html" title="type parameter in Union">S</a> summary)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.</div> +</div> +<div class="col-first even-row-color"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../Union.html" title="type parameter in Union">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Union.</span><code><a href="../Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">union</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Union.html" title="type parameter in Union">S</a>> tupleSketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../Union.html" title="type parameter in Union">S</a>> tupleSketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Perform a stateless, pair-wise union operation between two tuple sketches.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Subclasses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../adouble/DoubleSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Subclasses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../aninteger/IntegerSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Subclasses of <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../strings/ArrayOfStringsSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/Sketches.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Sketches.html new file mode 100644 index 000000000..9b7496bbf --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Sketches.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.Sketches (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: Sketches"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Sketches.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.Sketches" class="title">Uses of Class<br>org.apache.datasketches.tuple.Sketches</h1> +</div> +No usage of org.apache.datasketches.tuple.Sketches</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/Summary.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Summary.html new file mode 100644 index 000000000..dda9e1d54 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Summary.html @@ -0,0 +1,406 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.tuple.Summary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, interface: Summary"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.tuple.Summary" class="title">Uses of Interface<br>org.apache.datasketches.tuple.Summary</h1> +</div> +<div class="caption"><span>Packages that use <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last even-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<h2>Uses of <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></h2> +<div class="caption"><span>Methods in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a> with type parameters of type <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getEstimateOfBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the estimate for B over A</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second even-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">BoundsOnRatiosInTupleSketchedSets.</span><code><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with type parameters of type <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../AnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple">AnotB</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</div> +</div> +<div class="col-first odd-row-color"><code>final class </code></div> +<div class="col-second odd-row-color"><code><a href="../CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">CompactSketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last odd-row-color"> +<div class="block">CompactSketches are never created directly.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../Filter.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Filter</a><T extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">Class for filtering entries from a <a href="../Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="../Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../Intersection.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Intersection</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last odd-row-color"> +<div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches + combined with theta sketches.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../SummaryDeserializer.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for deserializing user-defined Summary</div> +</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../SummaryFactory.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined SummaryFactory</div> +</div> +<div class="col-first odd-row-color"><code>interface </code></div> +<div class="col-second odd-row-color"><code><a href="../SummarySetOperations.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last odd-row-color"> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../TupleSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over a generic tuple sketch</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../Union.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Union</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></div> +<div class="col-last odd-row-color"> +<div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with + theta sketches.</div> +</div> +</div> +<div class="caption"><span>Subinterfaces of <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Interface</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>interface </code></div> +<div class="col-second even-row-color"><code><a href="../UpdatableSummary.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U></code></div> +<div class="col-last even-row-color"> +<div class="block">Interface for updating user-defined Summary</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with type parameters of type <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">AnotB.</span><code><a href="../AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch)" class="member-name-link">aNotB</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skB)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Util.</span><code><a href="../Util.html#copySummaryArray(S%5B%5D)" class="member-name-link">copySummaryArray</a><wbr>(S[] summaryArr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#createEmptySketch()" class="member-name-link">createEmptySketch</a>()</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiate a Sketch from a given Memory.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Util.</span><code><a href="../Util.html#newSummaryArray(S%5B%5D,int)" class="member-name-link">newSummaryArray</a><wbr>(S[] summaryArr, + int length)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates a new Summary Array with the specified length</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Summary.</span><code><a href="../Summary.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Deep copy.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Util.</span><code><a href="../Util.html#copySummaryArray(S%5B%5D)" class="member-name-link">copySummaryArray</a><wbr>(S[] summaryArr)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Util.</span><code><a href="../Util.html#newSummaryArray(S%5B%5D,int)" class="member-name-link">newSummaryArray</a><wbr>(S[] summaryArr, + int length)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates a new Summary Array with the specified length</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">Util.</span><code><a href="../Util.html#copySummaryArray(S%5B%5D)" class="member-name-link">copySummaryArray</a><wbr>(S[] summaryArr)</code></div> +<div class="col-last even-row-color"> +<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>S[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Util.</span><code><a href="../Util.html#newSummaryArray(S%5B%5D,int)" class="member-name-link">newSummaryArray</a><wbr>(S[] summaryArr, + int length)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates a new Summary Array with the specified length</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Classes in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that implement <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../adouble/DoubleSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Summary for generic tuple sketches of type Double.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Classes in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that implement <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../aninteger/IntegerSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Summary for generic tuple sketches of type Integer.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Classes in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that implement <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../strings/ArrayOfStringsSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummaryDeserializer.html new file mode 100644 index 000000000..f71f35f71 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummaryDeserializer.html @@ -0,0 +1,171 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.tuple.SummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, interface: SummaryDeserializer"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.tuple.SummaryDeserializer" class="title">Uses of Interface<br>org.apache.datasketches.tuple.SummaryDeserializer</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer)" class="member-name-link">heapifySketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiate a Sketch from a given Memory.</div> +</div> +<div class="col-first odd-row-color"><code>static <U,<wbr> +S extends <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>><br><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer, + <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S> summaryFactory)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Instantiate UpdatableSketch from a given Memory</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../UpdatableSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> deserializer, + <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Classes in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that implement <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../adouble/DoubleSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Classes in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that implement <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../aninteger/IntegerSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Classes in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that implement <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../strings/ArrayOfStringsSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummaryFactory.html new file mode 100644 index 000000000..027694bd6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummaryFactory.html @@ -0,0 +1,193 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.tuple.SummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, interface: SummaryFactory"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.tuple.SummaryFactory" class="title">Uses of Interface<br>org.apache.datasketches.tuple.SummaryFactory</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="../Sketch.html" title="type parameter in Sketch">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#getSummaryFactory()" class="member-name-link">getSummaryFactory</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Gets the Summary Factory class of type S</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <U,<wbr> +S extends <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>><br><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer, + <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiate UpdatableSketch from a given Memory</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../UpdatableSketch.html#%3Cinit%3E(int,int,float,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketch</a><wbr>(int nomEntries, + int lgResizeFactor, + float samplingProbability, + <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to create a new instance of an UpdatableQuickSelectSketch.</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../UpdatableSketch.html#%3Cinit%3E(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory srcMem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> deserializer, + <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> summaryFactory)</code></div> +<div class="col-last odd-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../UpdatableSketchBuilder.html#%3Cinit%3E(org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">UpdatableSketchBuilder</a><wbr>(<a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates an instance of UpdatableSketchBuilder with default parameters</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Classes in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that implement <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../adouble/DoubleSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Factory for DoubleSummary.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Classes in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that implement <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../aninteger/IntegerSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Factory for IntegerSummary.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Classes in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that implement <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../strings/ArrayOfStringsSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummarySetOperations.html new file mode 100644 index 000000000..739ff851a --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/SummarySetOperations.html @@ -0,0 +1,238 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.tuple.SummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, interface: SummarySetOperations"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.tuple.SummarySetOperations" class="title">Uses of Interface<br>org.apache.datasketches.tuple.SummarySetOperations</h1> +</div> +<div class="caption"><span>Packages that use <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">dissimilarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">exactlyEqual</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns true if the two given sketches have exactly the same hash values and the same + theta values.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">jaccard</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div> +</div> +<div class="col-first even-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second even-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, + S summary, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last even-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +<div class="col-first odd-row-color"><code>static <S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></div> +<div class="col-second odd-row-color"><span class="type-name-label">JaccardSimilarity.</span><code><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)" class="member-name-link">similarityTest</a><wbr>(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, + <a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, + double threshold)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../Intersection.html#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Intersection</a><wbr>(<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="../Intersection.html" title="type parameter in Intersection">S</a>> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates new Intersection instance with instructions on how to process two summaries that + intersect.</div> +</div> +<div class="col-first odd-row-color"><code> </code></div> +<div class="col-second odd-row-color"><code><a href="../Union.html#%3Cinit%3E(int,org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Union</a><wbr>(int nomEntries, + <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="../Union.html" title="type parameter in Union">S</a>> summarySetOps)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Creates new Union instance.</div> +</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../Union.html#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)" class="member-name-link">Union</a><wbr>(<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="../Union.html" title="type parameter in Union">S</a>> summarySetOps)</code></div> +<div class="col-last even-row-color"> +<div class="block">Creates new Union instance with instructions on how to process two summaries that + overlap.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Classes in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that implement <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../adouble/DoubleSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Methods for defining how unions and intersections of two objects of type DoubleSummary + are performed.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Classes in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that implement <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../aninteger/IntegerSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary + are performed.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Classes in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that implement <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../strings/ArrayOfStringsSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/TupleSketchIterator.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/TupleSketchIterator.html new file mode 100644 index 000000000..37d63c71e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/TupleSketchIterator.html @@ -0,0 +1,96 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.TupleSketchIterator (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: TupleSketchIterator"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.TupleSketchIterator" class="title">Uses of Class<br>org.apache.datasketches.tuple.TupleSketchIterator</h1> +</div> +<div class="caption"><span>Packages that use <a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="../CompactSketch.html" title="type parameter in CompactSketch">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>abstract <a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="../Sketch.html" title="type parameter in Sketch">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">Sketch.</span><code><a href="../Sketch.html#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color"> +<div class="block">Returns a SketchIterator</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/Union.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Union.html new file mode 100644 index 000000000..79bb64e66 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Union.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.Union (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: Union"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Union.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.Union" class="title">Uses of Class<br>org.apache.datasketches.tuple.Union</h1> +</div> +No usage of org.apache.datasketches.tuple.Union</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSketch.html new file mode 100644 index 000000000..64e6f9de1 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSketch.html @@ -0,0 +1,189 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.UpdatableSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: UpdatableSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.UpdatableSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.UpdatableSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last odd-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<h2>Uses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../../fdt/package-summary.html">org.apache.datasketches.fdt</a></h2> +<div class="caption"><span>Subclasses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../../fdt/package-summary.html">org.apache.datasketches.fdt</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../fdt/FdtSketch.html" class="type-name-link" title="class in org.apache.datasketches.fdt">FdtSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A Frequent Distinct Tuples sketch.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdatableSketchBuilder.</span><code><a href="../UpdatableSketchBuilder.html#build()" class="member-name-link">build</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Returns an UpdatableSketch with the current configuration of this Builder.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdatableSketch.</span><code><a href="../UpdatableSketch.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>static <U,<wbr> +S extends <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>><br><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer, + <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiate UpdatableSketch from a given Memory</div> +</div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../UpdatableSketch.html#%3Cinit%3E(org.apache.datasketches.tuple.UpdatableSketch)" class="member-name-link">UpdatableSketch</a><wbr>(<a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<wbr><a href="../UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Copy Constructor</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Subclasses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../adouble/DoubleSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Subclasses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../aninteger/IntegerSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Subclasses of <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../strings/ArrayOfStringsSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSketchBuilder.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSketchBuilder.html new file mode 100644 index 000000000..4af78214e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSketchBuilder.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.UpdatableSketchBuilder (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: UpdatableSketchBuilder"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.UpdatableSketchBuilder" class="title">Uses of Class<br>org.apache.datasketches.tuple.UpdatableSketchBuilder</h1> +</div> +<div class="caption"><span>Packages that use <a href="../UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdatableSketchBuilder.</span><code><a href="../UpdatableSketchBuilder.html#setNominalEntries(int)" class="member-name-link">setNominalEntries</a><wbr>(int nomEntries)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to set the nominal number of entries.</div> +</div> +<div class="col-first odd-row-color"><code><a href="../UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">UpdatableSketchBuilder.</span><code><a href="../UpdatableSketchBuilder.html#setResizeFactor(org.apache.datasketches.common.ResizeFactor)" class="member-name-link">setResizeFactor</a><wbr>(<a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> resizeFactor)</code></div> +<div class="col-last odd-row-color"> +<div class="block">This is to set the resize factor.</div> +</div> +<div class="col-first even-row-color"><code><a href="../UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,<wbr><a href="../UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdatableSketchBuilder.</span><code><a href="../UpdatableSketchBuilder.html#setSamplingProbability(float)" class="member-name-link">setSamplingProbability</a><wbr>(float samplingProbability)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to set sampling probability.</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSummary.html new file mode 100644 index 000000000..a4d2d73e0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/UpdatableSummary.html @@ -0,0 +1,181 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Interface org.apache.datasketches.tuple.UpdatableSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, interface: UpdatableSummary"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Interface org.apache.datasketches.tuple.UpdatableSummary" class="title">Uses of Interface<br>org.apache.datasketches.tuple.UpdatableSummary</h1> +</div> +<div class="caption"><span>Packages that use <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<h2>Uses of <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h2> +<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with type parameters of type <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S extends <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></code></div> +<div class="col-last even-row-color"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +<div class="col-first odd-row-color"><code>class </code></div> +<div class="col-second odd-row-color"><code><a href="../UpdatableSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><U,<wbr>S extends <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></code></div> +<div class="col-last odd-row-color"> +<div class="block">For building a new generic tuple UpdatableSketch</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with type parameters of type <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static <U,<wbr> +S extends <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>><br><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S></code></div> +<div class="col-second even-row-color"><span class="type-name-label">Sketches.</span><code><a href="../Sketches.html#heapifyUpdatableSketch(org.apache.datasketches.memory.Memory,org.apache.datasketches.tuple.SummaryDeserializer,org.apache.datasketches.tuple.SummaryFactory)" class="member-name-link">heapifyUpdatableSketch</a><wbr>(org.apache.datasketches.memory.Memory mem, + <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S> deserializer, + <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S> summaryFactory)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiate UpdatableSketch from a given Memory</div> +</div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="../UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">UpdatableSummary.</span><code><a href="../UpdatableSummary.html#update(U)" class="member-name-link">update</a><wbr>(<a href="../UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a> value)</code></div> +<div class="col-last even-row-color"> +<div class="block">This is to provide a method of updating summaries.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<h2>Uses of <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h2> +<div class="caption"><span>Classes in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that implement <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../adouble/DoubleSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Summary for generic tuple sketches of type Double.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<h2>Uses of <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h2> +<div class="caption"><span>Classes in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that implement <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>class </code></div> +<div class="col-second even-row-color"><code><a href="../aninteger/IntegerSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Summary for generic tuple sketches of type Integer.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Classes in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that implement <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../strings/ArrayOfStringsSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/class-use/Util.html b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Util.html new file mode 100644 index 000000000..64d75870e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/class-use/Util.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.Util (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple, class: Util"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../Util.html" title="class in org.apache.datasketches.tuple">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.Util" class="title">Uses of Class<br>org.apache.datasketches.tuple.Util</h1> +</div> +No usage of org.apache.datasketches.tuple.Util</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/package-summary.html b/docs/7.0.X/org/apache/datasketches/tuple/package-summary.html new file mode 100644 index 000000000..b823a3669 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/package-summary.html @@ -0,0 +1,209 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.tuple" class="title">Package org.apache.datasketches.tuple</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.tuple</span></div> +<section class="package-description" id="package-description"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is the parent package for all sketch families and common code areas.</div> +</div> +<div class="col-first odd-row-color"><a href="adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +<div class="col-first even-row-color"><a href="strings/package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> +<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">CompactSketches are never created directly.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><T></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Filter.html" title="class in org.apache.datasketches.tuple">Filter</a><T extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Class for filtering entries from a <a href="Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches + combined with theta sketches.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Jaccard similarity of two Tuple Sketches, or alternatively, of a Tuple and Theta Sketch.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Multipurpose serializer-deserializer for a collection of sketches defined by the enum.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="SerializerDeserializer.SketchType.html" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab3"> +<div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Convenient static methods to instantiate generic tuple sketches.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">Interface for deserializing user-defined Summary</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">Interface for user-defined SummaryFactory</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color class-summary class-summary-tab1"> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">Iterator over a generic tuple sketch</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Union.html" title="class in org.apache.datasketches.tuple">Union</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with + theta sketches.</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><U,<wbr>S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">For building a new generic tuple UpdatableSketch</div> +</div> +<div class="col-first even-row-color class-summary class-summary-tab1"><a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U></div> +<div class="col-last even-row-color class-summary class-summary-tab1"> +<div class="block">Interface for updating user-defined Summary</div> +</div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Util.html" title="class in org.apache.datasketches.tuple">Util</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> +<div class="block">Common utility functions for Tuples</div> +</div> +</div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/package-tree.html b/docs/7.0.X/org/apache/datasketches/tuple/package-tree.html new file mode 100644 index 000000000..ddae39f3e --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/package-tree.html @@ -0,0 +1,119 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.tuple"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.tuple</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="AnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple">AnotB</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="DeserializeResult.html" class="type-name-link" title="class in org.apache.datasketches.tuple">DeserializeResult</a><T></li> +<li class="circle">org.apache.datasketches.tuple.<a href="Filter.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Filter</a><T></li> +<li class="circle">org.apache.datasketches.tuple.<a href="Intersection.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Intersection</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="JaccardSimilarity.html" class="type-name-link" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="SerializerDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><S> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.<a href="Sketches.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketches</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="TupleSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="Union.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Union</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="UpdatableSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><U,<wbr>S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="Util.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Util</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="Summary.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">Summary</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="UpdatableSummary.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.<a href="SummaryDeserializer.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="SummaryFactory.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="SummarySetOperations.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S></li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="SerializerDeserializer.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/package-use.html b/docs/7.0.X/org/apache/datasketches/tuple/package-use.html new file mode 100644 index 000000000..0127a22f5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/package-use.html @@ -0,0 +1,324 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.tuple (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.tuple" class="title">Uses of Package<br>org.apache.datasketches.tuple</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.tuple</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package contains common tools and methods for the <i>theta</i>, + <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple</a> used by <a href="../fdt/package-summary.html">org.apache.datasketches.fdt</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.fdt">Sketch</a></div> +<div class="col-last even-row-color"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdatableSketch.html#org.apache.datasketches.fdt">UpdatableSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.thetacommon"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple</a> used by <a href="../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.thetacommon">Sketch</a></div> +<div class="col-last even-row-color"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Summary.html#org.apache.datasketches.thetacommon">Summary</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple</a> used by <a href="package-summary.html">org.apache.datasketches.tuple</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/CompactSketch.html#org.apache.datasketches.tuple">CompactSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">CompactSketches are never created directly.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/DeserializeResult.html#org.apache.datasketches.tuple">DeserializeResult</a></div> +<div class="col-last odd-row-color"> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SerializerDeserializer.SketchType.html#org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></div> +<div class="col-last even-row-color"> +<div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.tuple">Sketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/Summary.html#org.apache.datasketches.tuple">Summary</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummaryDeserializer.html#org.apache.datasketches.tuple">SummaryDeserializer</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for deserializing user-defined Summary</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SummaryFactory.html#org.apache.datasketches.tuple">SummaryFactory</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined SummaryFactory</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummarySetOperations.html#org.apache.datasketches.tuple">SummarySetOperations</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/TupleSketchIterator.html#org.apache.datasketches.tuple">TupleSketchIterator</a></div> +<div class="col-last even-row-color"> +<div class="block">Iterator over a generic tuple sketch</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdatableSketch.html#org.apache.datasketches.tuple">UpdatableSketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/UpdatableSketchBuilder.html#org.apache.datasketches.tuple">UpdatableSketchBuilder</a></div> +<div class="col-last even-row-color"> +<div class="block">For building a new generic tuple UpdatableSketch</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdatableSummary.html#org.apache.datasketches.tuple">UpdatableSummary</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for updating user-defined Summary</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.adouble"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple</a> used by <a href="adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/DeserializeResult.html#org.apache.datasketches.tuple.adouble">DeserializeResult</a></div> +<div class="col-last even-row-color"> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.tuple.adouble">Sketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/Summary.html#org.apache.datasketches.tuple.adouble">Summary</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummaryDeserializer.html#org.apache.datasketches.tuple.adouble">SummaryDeserializer</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for deserializing user-defined Summary</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SummaryFactory.html#org.apache.datasketches.tuple.adouble">SummaryFactory</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined SummaryFactory</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummarySetOperations.html#org.apache.datasketches.tuple.adouble">SummarySetOperations</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/UpdatableSketch.html#org.apache.datasketches.tuple.adouble">UpdatableSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdatableSummary.html#org.apache.datasketches.tuple.adouble">UpdatableSummary</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for updating user-defined Summary</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.aninteger"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple</a> used by <a href="aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/DeserializeResult.html#org.apache.datasketches.tuple.aninteger">DeserializeResult</a></div> +<div class="col-last even-row-color"> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.tuple.aninteger">Sketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/Summary.html#org.apache.datasketches.tuple.aninteger">Summary</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummaryDeserializer.html#org.apache.datasketches.tuple.aninteger">SummaryDeserializer</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for deserializing user-defined Summary</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SummaryFactory.html#org.apache.datasketches.tuple.aninteger">SummaryFactory</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined SummaryFactory</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummarySetOperations.html#org.apache.datasketches.tuple.aninteger">SummarySetOperations</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/UpdatableSketch.html#org.apache.datasketches.tuple.aninteger">UpdatableSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdatableSummary.html#org.apache.datasketches.tuple.aninteger">UpdatableSummary</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for updating user-defined Summary</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple</a> used by <a href="strings/package-summary.html">org.apache.datasketches.tuple.strings</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/DeserializeResult.html#org.apache.datasketches.tuple.strings">DeserializeResult</a></div> +<div class="col-last even-row-color"> +<div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/Sketch.html#org.apache.datasketches.tuple.strings">Sketch</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with + addition of a user-defined Summary object associated with every unique entry + in the sketch.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/Summary.html#org.apache.datasketches.tuple.strings">Summary</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummaryDeserializer.html#org.apache.datasketches.tuple.strings">SummaryDeserializer</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for deserializing user-defined Summary</div> +</div> +<div class="col-first even-row-color"><a href="class-use/SummaryFactory.html#org.apache.datasketches.tuple.strings">SummaryFactory</a></div> +<div class="col-last even-row-color"> +<div class="block">Interface for user-defined SummaryFactory</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/SummarySetOperations.html#org.apache.datasketches.tuple.strings">SummarySetOperations</a></div> +<div class="col-last odd-row-color"> +<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> +</div> +<div class="col-first even-row-color"><a href="class-use/UpdatableSketch.html#org.apache.datasketches.tuple.strings">UpdatableSketch</a></div> +<div class="col-last even-row-color"> +<div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> +</div> +<div class="col-first odd-row-color"><a href="class-use/UpdatableSummary.html#org.apache.datasketches.tuple.strings">UpdatableSummary</a></div> +<div class="col-last odd-row-color"> +<div class="block">Interface for updating user-defined Summary</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html new file mode 100644 index 000000000..11607c894 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html @@ -0,0 +1,493 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfStringsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSketch"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfStringsSketch.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<h1 title="Class ArrayOfStringsSketch" class="title">Class ArrayOfStringsSketch</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S> +<div class="inheritance"><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[],<wbr><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>> +<div class="inheritance">org.apache.datasketches.tuple.strings.ArrayOfStringsSketch</div> +</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="../../fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfStringsSketch</span> +<span class="extends-implements">extends <a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[],<wbr><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSketch</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs new sketch with default <i>K</i> = 4096 (<i>lgK</i> = 12), default ResizeFactor=X8, + and default <i>p</i> = 1.0.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">ArrayOfStringsSketch</a><wbr>(int lgK)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Constructs new sketch with default ResizeFactor=X8, default <i>p</i> = 1.0 and given <i>lgK</i>.</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,org.apache.datasketches.common.ResizeFactor,float)" class="member-name-link">ArrayOfStringsSketch</a><wbr>(int lgK, + <a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf, + float p)</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs new sketch with given ResizeFactor, <i>p</i> and <i>lgK</i>.</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.memory.Memory)" class="member-name-link">ArrayOfStringsSketch</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last odd-row-color"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.strings.ArrayOfStringsSketch)" class="member-name-link">ArrayOfStringsSketch</a><wbr>(<a href="ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Copy Constructor</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compact()" class="member-name-link">compact</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCountLessThanThetaLong(long)" class="member-name-link">getCountLessThanThetaLong</a><wbr>(long thetaLong)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentCapacity()" class="member-name-link">getCurrentCapacity</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get current capacity</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLgK()" class="member-name-link">getLgK</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get log_base2 of Nominal Entries</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNominalEntries()" class="member-name-link">getNominalEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured nominal number of entries</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResizeFactor()" class="member-name-link">getResizeFactor</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured resize factor</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetainedEntries()" class="member-name-link">getRetainedEntries</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplingProbability()" class="member-name-link">getSamplingProbability</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Get configured sampling probability</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Returns a SketchIterator</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Resets this sketch an empty state.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>byte[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> +<div class="block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated.</div> +</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trim()" class="member-name-link">trim</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String%5B%5D,java.lang.String%5B%5D)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArrKey, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArr)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Updates the sketch with String arrays for both key and value.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.UpdatableSketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></h3> +<code><a href="../UpdatableSketch.html#update(byte%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(double,U)">update</a>, <a href="../UpdatableSketch.html#update(int%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(long%5B%5D,U)">update</a>, <a href="../UpdatableSketch.html#update(long,U)">update</a>, <a href="../UpdatableSketch.html#update(java.lang.String,U)">update</a>, <a href="../UpdatableSketch.html#update(java.nio.ByteBuffer,U)">update</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.datasketches.tuple.Sketch">Methods inherited from class org.apache.datasketches.tuple.<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> +<code><a href="../Sketch.html#getEstimate()">getEstimate</a>, <a href="../Sketch.html#getEstimate(int)">getEstimate</a>, <a href="../Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="../Sketch.html#getLowerBound(int,int)">getLowerBound</a>, <a href="../Sketch.html#getSummaryFactory()">getSummaryFactory</a>, <a href="../Sketch.html#getTheta()">getTheta</a>, <a href="../Sketch.html#getThetaLong()">getThetaLong</a>, <a href="../Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="../Sketch.html#getUpperBound(int,int)">getUpperBound</a>, <a href="../Sketch.html#isEmpty()">isEmpty</a>, <a href="../Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="../Sketch.html#toString()">toString</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfStringsSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSketch</span>()</div> +<div class="block">Constructs new sketch with default <i>K</i> = 4096 (<i>lgK</i> = 12), default ResizeFactor=X8, + and default <i>p</i> = 1.0.</div> +</section> +</li> +<li> +<section class="detail" id="<init>(int)"> +<h3>ArrayOfStringsSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSketch</span><wbr><span class="parameters">(int lgK)</span></div> +<div class="block">Constructs new sketch with default ResizeFactor=X8, default <i>p</i> = 1.0 and given <i>lgK</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - Log_base2 of <i>Nominal Entries</i>. + <a href="../../../../../resources/dictionary.html#nomEntries">See Nominal Entries</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(int,org.apache.datasketches.common.ResizeFactor,float)"> +<h3>ArrayOfStringsSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSketch</span><wbr><span class="parameters">(int lgK, + <a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a> rf, + float p)</span></div> +<div class="block">Constructs new sketch with given ResizeFactor, <i>p</i> and <i>lgK</i>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>lgK</code> - Log_base2 of <i>Nominal Entries</i>. + <a href="../../../../../resources/dictionary.html#nomEntries">See Nominal Entries</a></dd> +<dd><code>rf</code> - ResizeFactor + <a href="../../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> +<dd><code>p</code> - sampling probability + <a href="../../../../../resources/dictionary.html#p">See Sampling Probability</a></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.memory.Memory)"> +<h3>ArrayOfStringsSketch</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSketch</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, heapifying an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Heapifying a CompactSketch is not deprecated.</div> +</div> +<div class="block">Constructs this sketch from a Memory image, which must be from an ArrayOfStringsSketch, and + usually with data.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>mem</code> - the given Memory</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(org.apache.datasketches.tuple.strings.ArrayOfStringsSketch)"> +<h3>ArrayOfStringsSketch</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSketch</span><wbr><span class="parameters">(<a href="ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> sketch)</span></div> +<div class="block">Copy Constructor</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>sketch</code> - the sketch to copy</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></span> <span class="element-name">copy</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="../UpdatableSketch.html#copy()">copy</a></code> in class <code><a href="../UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[],<wbr><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +<dt>Returns:</dt> +<dd>a deep copy of this sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String[],java.lang.String[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArrKey, + <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] strArr)</span></div> +<div class="block">Updates the sketch with String arrays for both key and value.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>strArrKey</code> - the given String array key</dd> +<dd><code>strArr</code> - the given String array value</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRetainedEntries()"> +<h3>getRetainedEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRetainedEntries</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#getRetainedEntries()">getRetainedEntries</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>number of retained entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCountLessThanThetaLong(long)"> +<h3>getCountLessThanThetaLong</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCountLessThanThetaLong</span><wbr><span class="parameters">(long thetaLong)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../Sketch.html#getCountLessThanThetaLong(long)">Sketch</a></code></span></div> +<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> +<dt>Returns:</dt> +<dd>the number of hash values less than the given thetaLong.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getNominalEntries()"> +<h3>getNominalEntries</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNominalEntries</span>()</div> +<div class="block">Get configured nominal number of entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>nominal number of entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getLgK()"> +<h3>getLgK</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLgK</span>()</div> +<div class="block">Get log_base2 of Nominal Entries</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>log_base2 of Nominal Entries</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSamplingProbability()"> +<h3>getSamplingProbability</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getSamplingProbability</span>()</div> +<div class="block">Get configured sampling probability</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>sampling probability</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getCurrentCapacity()"> +<h3>getCurrentCapacity</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getCurrentCapacity</span>()</div> +<div class="block">Get current capacity</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>current capacity</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getResizeFactor()"> +<h3>getResizeFactor</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/ResizeFactor.html" title="enum class in org.apache.datasketches.common">ResizeFactor</a></span> <span class="element-name">getResizeFactor</span>()</div> +<div class="block">Get configured resize factor</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>resize factor</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="trim()"> +<h3>trim</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">trim</span>()</div> +<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> +</section> +</li> +<li> +<section class="detail" id="reset()"> +<h3>reset</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> +<div class="block">Resets this sketch an empty state.</div> +</section> +</li> +<li> +<section class="detail" id="compact()"> +<h3>compact</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span> <span class="element-name">compact</span>()</div> +<div class="block">Converts the current state of the sketch into a compact sketch</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#compact()">compact</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>compact sketch</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> +</span><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">As of 3.0.0, serializing an UpdatableSketch is deprecated. + This capability will be removed in a future release. + Serializing a CompactSketch is not deprecated.</div> +</div> +<div class="block">This serializes an UpdatableSketch (QuickSelectSketch).</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#toByteArray()">toByteArray</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of an UpdatableSketch (QuickSelectSketch).</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="iterator()"> +<h3>iterator</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span> <span class="element-name">iterator</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../Sketch.html#iterator()">Sketch</a></code></span></div> +<div class="block">Returns a SketchIterator</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Sketch.html#iterator()">iterator</a></code> in class <code><a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> +<dt>Returns:</dt> +<dd>a SketchIterator</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html new file mode 100644 index 000000000..0e97ee9b6 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html @@ -0,0 +1,240 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfStringsSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummary"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfStringsSummary.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<h1 title="Class ArrayOfStringsSummary" class="title">Class ArrayOfStringsSummary</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.strings.ArrayOfStringsSummary</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code>, <code><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ArrayOfStringsSummary</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Deep copy.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> summary)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValue()" class="member-name-link">getValue</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray()" class="member-name-link">toByteArray</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to serialize a Summary instance to a byte array.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String%5B%5D)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] value)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to provide a method of updating summaries.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="copy()"> +<h3>copy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span> <span class="element-name">copy</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Summary.html#copy()">Summary</a></code></span></div> +<div class="block">Deep copy. + + <p><b>Caution:</b> This must implement a deep copy.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Summary.html#copy()">copy</a></code> in interface <code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></dd> +<dt>Returns:</dt> +<dd>deep copy of the Summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="toByteArray()"> +<h3>toByteArray</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Summary.html#toByteArray()">Summary</a></code></span></div> +<div class="block">This is to serialize a Summary instance to a byte array. + + <p>The user should encode in the byte array its total size, which is used during + deserialization, especially if the Summary has variable sized elements.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../Summary.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></dd> +<dt>Returns:</dt> +<dd>serialized representation of the Summary</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="update(java.lang.String[])"> +<h3>update</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span> <span class="element-name">update</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] value)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../UpdatableSummary.html#update(U)">UpdatableSummary</a></code></span></div> +<div class="block">This is to provide a method of updating summaries. + This is primarily used internally.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../UpdatableSummary.html#update(U)">update</a></code> in interface <code><a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]></code></dd> +<dt>Parameters:</dt> +<dd><code>value</code> - update value</dd> +<dt>Returns:</dt> +<dd>this</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashCode()"> +<h3>hashCode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="equals(java.lang.Object)"> +<h3>equals</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> summary)</span></div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getValue()"> +<h3>getValue</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">getValue</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the nodes array for this summary.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html new file mode 100644 index 000000000..b95f5c5ea --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html @@ -0,0 +1,189 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfStringsSummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummaryDeserializer"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfStringsSummaryDeserializer.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<h1 title="Class ArrayOfStringsSummaryDeserializer" class="title">Class ArrayOfStringsSummaryDeserializer</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryDeserializer</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfStringsSummaryDeserializer</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSummaryDeserializer</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is to create an instance of a Summary given a serialized representation.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfStringsSummaryDeserializer</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSummaryDeserializer</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="heapifySummary(org.apache.datasketches.memory.Memory)"> +<h3>heapifySummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span> <span class="element-name">heapifySummary</span><wbr><span class="parameters">(org.apache.datasketches.memory.Memory mem)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)">SummaryDeserializer</a></code></span></div> +<div class="block">This is to create an instance of a Summary given a serialized representation. + The user may assume that the start of the given Memory is the correct place to start + deserializing. However, the user must be able to determine the number of bytes required to + deserialize the summary as the capacity of the given Memory may + include multiple such summaries and may be much larger than required for a single summary.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)">heapifySummary</a></code> in interface <code><a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>mem</code> - Memory object with serialized representation of a Summary</dd> +<dt>Returns:</dt> +<dd>DeserializedResult object, which contains a Summary object and number of bytes read + from the Memory</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html new file mode 100644 index 000000000..b1f9b7b96 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html @@ -0,0 +1,178 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfStringsSummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummaryFactory"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfStringsSummaryFactory.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<h1 title="Class ArrayOfStringsSummaryFactory" class="title">Class ArrayOfStringsSummaryFactory</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryFactory</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfStringsSummaryFactory</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSummaryFactory</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newSummary()" class="member-name-link">newSummary</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfStringsSummaryFactory</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSummaryFactory</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="newSummary()"> +<h3>newSummary</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span> <span class="element-name">newSummary</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummaryFactory.html#newSummary()">newSummary</a></code> in interface <code><a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +<dt>Returns:</dt> +<dd>new instance of Summary</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html new file mode 100644 index 000000000..23f3b04ac --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html @@ -0,0 +1,221 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>ArrayOfStringsSummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummarySetOperations"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/ArrayOfStringsSummarySetOperations.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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datasketches.tuple.strings</a></div> +<h1 title="Class ArrayOfStringsSummarySetOperations" class="title">Class ArrayOfStringsSummarySetOperations</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.datasketches.tuple.strings.ArrayOfStringsSummarySetOperations</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArrayOfStringsSummarySetOperations</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></span></div> +<dl class="notes"> +<dt>Author:</dt> +<dd>Lee Rhodes</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ArrayOfStringsSummarySetOperations</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersection(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">intersection</a><wbr>(<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is called by the intersection operator when both sketches have the same hash value.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">union</a><wbr>(<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">This is called by the union operator when both sketches have the same hash value.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>ArrayOfStringsSummarySetOperations</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArrayOfStringsSummarySetOperations</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="union(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)"> +<h3>union</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#union(S,S)">SummarySetOperations</a></code></span></div> +<div class="block">This is called by the union operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummarySetOperations.html#union(S,S)">union</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>union of Summary A and Summary B</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="intersection(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)"> +<h3>intersection</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span> <span class="element-name">intersection</span><wbr><span class="parameters">(<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#intersection(S,S)">SummarySetOperations</a></code></span></div> +<div class="block">This is called by the intersection operator when both sketches have the same hash value. + + <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, + unless they are immutable (most Summary objects are not). For mutable Summary objects, it is + important to create a new Summary object with the correct contents to be returned. Do not + return null summaries.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="../SummarySetOperations.html#intersection(S,S)">intersection</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></dd> +<dt>Parameters:</dt> +<dd><code>a</code> - Summary from sketch A</dd> +<dd><code>b</code> - Summary from sketch B</dd> +<dt>Returns:</dt> +<dd>intersection of Summary A and Summary B</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSketch.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSketch.html new file mode 100644 index 000000000..e237fd5b0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSketch.html @@ -0,0 +1,120 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSketch (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSketch"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.strings.ArrayOfStringsSketch</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<h2>Uses of <a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> in <a href="../../../fdt/package-summary.html">org.apache.datasketches.fdt</a></h2> +<div class="caption"><span>Subclasses of <a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> in <a href="../../../fdt/package-summary.html">org.apache.datasketches.fdt</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final class </code></div> +<div class="col-second even-row-color"><code><a href="../../../fdt/FdtSketch.html" class="type-name-link" title="class in org.apache.datasketches.fdt">FdtSketch</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A Frequent Distinct Tuples sketch.</div> +</div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.strings</a> that return <a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfStringsSketch.</span><code><a href="../ArrayOfStringsSketch.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple.strings</a> with parameters of type <a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier</div> +<div class="table-header col-second">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code> </code></div> +<div class="col-second even-row-color"><code><a href="../ArrayOfStringsSketch.html#%3Cinit%3E(org.apache.datasketches.tuple.strings.ArrayOfStringsSketch)" class="member-name-link">ArrayOfStringsSketch</a><wbr>(<a href="../ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> sketch)</code></div> +<div class="col-last even-row-color"> +<div class="block">Copy Constructor</div> +</div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummary.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummary.html new file mode 100644 index 000000000..ed6ff072f --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummary.html @@ -0,0 +1,126 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummary (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummary"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummary" class="title">Uses of Class<br>org.apache.datasketches.tuple.strings.ArrayOfStringsSummary</h1> +</div> +<div class="caption"><span>Packages that use <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="class-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<h2>Uses of <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> in <a href="../package-summary.html">org.apache.datasketches.tuple.strings</a></h2> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.strings</a> that return <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfStringsSummary.</span><code><a href="../ArrayOfStringsSummary.html#copy()" class="member-name-link">copy</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfStringsSummarySetOperations.</span><code><a href="../ArrayOfStringsSummarySetOperations.html#intersection(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">intersection</a><wbr>(<a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfStringsSummaryFactory.</span><code><a href="../ArrayOfStringsSummaryFactory.html#newSummary()" class="member-name-link">newSummary</a>()</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfStringsSummarySetOperations.</span><code><a href="../ArrayOfStringsSummarySetOperations.html#union(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">union</a><wbr>(<a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfStringsSummary.</span><code><a href="../ArrayOfStringsSummary.html#update(java.lang.String%5B%5D)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] value)</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.strings</a> that return types with arguments of type <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../../DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfStringsSummaryDeserializer.</span><code><a href="../ArrayOfStringsSummaryDeserializer.html#heapifySummary(org.apache.datasketches.memory.Memory)" class="member-name-link">heapifySummary</a><wbr>(org.apache.datasketches.memory.Memory mem)</code></div> +<div class="col-last even-row-color"> </div> +</div> +<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple.strings</a> with parameters of type <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second even-row-color"><span class="type-name-label">ArrayOfStringsSummarySetOperations.</span><code><a href="../ArrayOfStringsSummarySetOperations.html#intersection(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">intersection</a><wbr>(<a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></code></div> +<div class="col-second odd-row-color"><span class="type-name-label">ArrayOfStringsSummarySetOperations.</span><code><a href="../ArrayOfStringsSummarySetOperations.html#union(org.apache.datasketches.tuple.strings.ArrayOfStringsSummary,org.apache.datasketches.tuple.strings.ArrayOfStringsSummary)" class="member-name-link">union</a><wbr>(<a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> a, + <a href="../ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> b)</code></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummaryDeserializer.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummaryDeserializer.html new file mode 100644 index 000000000..796beb211 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummaryDeserializer.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryDeserializer (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummaryDeserializer"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfStringsSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.strings">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryDeserializer" class="title">Uses of Class<br>org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryDeserializer</h1> +</div> +No usage of org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryDeserializer</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummaryFactory.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummaryFactory.html new file mode 100644 index 000000000..e158640d5 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummaryFactory.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryFactory (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummaryFactory"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfStringsSummaryFactory.html" title="class in org.apache.datasketches.tuple.strings">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryFactory" class="title">Uses of Class<br>org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryFactory</h1> +</div> +No usage of org.apache.datasketches.tuple.strings.ArrayOfStringsSummaryFactory</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummarySetOperations.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummarySetOperations.html new file mode 100644 index 000000000..0def89311 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/class-use/ArrayOfStringsSummarySetOperations.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummarySetOperations (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.strings, class: ArrayOfStringsSummarySetOperations"> +<meta name="generator" content="javadoc/ClassUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">Class</a></li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Class org.apache.datasketches.tuple.strings.ArrayOfStringsSummarySetOperations" class="title">Uses of Class<br>org.apache.datasketches.tuple.strings.ArrayOfStringsSummarySetOperations</h1> +</div> +No usage of org.apache.datasketches.tuple.strings.ArrayOfStringsSummarySetOperations</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/package-summary.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/package-summary.html new file mode 100644 index 000000000..e5feec8b0 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/package-summary.html @@ -0,0 +1,125 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.strings (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.datasketches.tuple.strings"> +<meta name="generator" content="javadoc/PackageWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li class="nav-bar-cell1-rev">Package</li> +<li>Class</li> +<li><a href="package-use.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#package">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Package: </li> +<li><a href="#package-description">Description</a> | </li> +<li><a href="#related-package-summary">Related Packages</a> | </li> +<li><a href="#class-summary">Classes and Interfaces</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Package org.apache.datasketches.tuple.strings" class="title">Package org.apache.datasketches.tuple.strings</h1> +</div> +<hr> +<div class="package-signature">package <span class="element-name">org.apache.datasketches.tuple.strings</span></div> +<section class="package-description" id="package-description"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<li> +<div id="related-package-summary"> +<div class="caption"><span>Related Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.datasketches.tuple</a></div> +<div class="col-last even-row-color"> +<div class="block">The tuple package contains a number of sketches based on the same + fundamental algorithms of the Theta Sketch Framework and extend these + concepts for whole new families of sketches.</div> +</div> +<div class="col-first odd-row-color"><a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> +</div> +<div class="col-first even-row-color"><a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> +<div class="col-last even-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> +</div> +<div class="col-first odd-row-color"><a href="../arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> +</div> +</div> +</div> +</li> +<li> +<div id="class-summary"> +<div class="caption"><span>Classes</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> </div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> </div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfStringsSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> </div> +<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArrayOfStringsSummaryFactory.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a></div> +<div class="col-last odd-row-color class-summary class-summary-tab2"> </div> +<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></div> +<div class="col-last even-row-color class-summary class-summary-tab2"> </div> +</div> +</div> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/package-tree.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/package-tree.html new file mode 100644 index 000000000..e2d2d4352 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/package-tree.html @@ -0,0 +1,88 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>org.apache.datasketches.tuple.strings Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="tree: package: org.apache.datasketches.tuple.strings"> +<meta name="generator" content="javadoc/PackageTreeWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-tree-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.datasketches.tuple.strings</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="ArrayOfStringsSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> (implements org.apache.datasketches.tuple.<a href="../UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>)</li> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="ArrayOfStringsSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a> (implements org.apache.datasketches.tuple.<a href="../SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="ArrayOfStringsSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a> (implements org.apache.datasketches.tuple.<a href="../SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="ArrayOfStringsSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a> (implements org.apache.datasketches.tuple.<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.<a href="../Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><S> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="../UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S> +<ul> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="ArrayOfStringsSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/org/apache/datasketches/tuple/strings/package-use.html b/docs/7.0.X/org/apache/datasketches/tuple/strings/package-use.html new file mode 100644 index 000000000..1bc3ba593 --- /dev/null +++ b/docs/7.0.X/org/apache/datasketches/tuple/strings/package-use.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Uses of Package org.apache.datasketches.tuple.strings (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="use: package: org.apache.datasketches.tuple.strings"> +<meta name="generator" content="javadoc/PackageUseWriter"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-use-page"> +<script type="text/javascript">var pathtoroot = "../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Uses of Package org.apache.datasketches.tuple.strings" class="title">Uses of Package<br>org.apache.datasketches.tuple.strings</h1> +</div> +<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.datasketches.tuple.strings</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="#org.apache.datasketches.fdt">org.apache.datasketches.fdt</a></div> +<div class="col-last even-row-color"> +<div class="block">Frequent Distinct Tuples Sketch</div> +</div> +<div class="col-first odd-row-color"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></div> +<div class="col-last odd-row-color"> +<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> +</div> +</div> +<section class="package-uses"> +<ul class="block-list"> +<li> +<section class="detail" id="org.apache.datasketches.fdt"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple.strings</a> used by <a href="../../fdt/package-summary.html">org.apache.datasketches.fdt</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfStringsSketch.html#org.apache.datasketches.fdt">ArrayOfStringsSketch</a></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<li> +<section class="detail" id="org.apache.datasketches.tuple.strings"> +<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.datasketches.tuple.strings</a> used by <a href="package-summary.html">org.apache.datasketches.tuple.strings</a></span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><a href="class-use/ArrayOfStringsSketch.html#org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><a href="class-use/ArrayOfStringsSummary.html#org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></div> +<div class="col-last odd-row-color"> </div> +</div> +</section> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/overview-summary.html b/docs/7.0.X/overview-summary.html new file mode 100644 index 000000000..4ef4df2fc --- /dev/null +++ b/docs/7.0.X/overview-summary.html @@ -0,0 +1,25 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>datasketches-java 7.0.0 API</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="index redirect"> +<meta name="generator" content="javadoc/IndexRedirectWriter"> +<link rel="canonical" href="index.html"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<script type="text/javascript">window.location.replace('index.html')</script> +<noscript> +<meta http-equiv="Refresh" content="0;index.html"> +</noscript> +</head> +<body class="index-redirect-page"> +<main role="main"> +<noscript> +<p>JavaScript is disabled on your browser.</p> +</noscript> +<p><a href="index.html">index.html</a></p> +</main> +</body> +</html> diff --git a/docs/7.0.X/overview-tree.html b/docs/7.0.X/overview-tree.html new file mode 100644 index 000000000..433e812f2 --- /dev/null +++ b/docs/7.0.X/overview-tree.html @@ -0,0 +1,398 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Class Hierarchy (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="class tree"> +<meta name="generator" content="javadoc/TreeWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="tree-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Hierarchy For All Packages</h1> +<span class="package-hierarchy-label">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="org/apache/datasketches/package-tree.html">org.apache.datasketches</a>, </li> +<li><a href="org/apache/datasketches/common/package-tree.html">org.apache.datasketches.common</a>, </li> +<li><a href="org/apache/datasketches/cpc/package-tree.html">org.apache.datasketches.cpc</a>, </li> +<li><a href="org/apache/datasketches/fdt/package-tree.html">org.apache.datasketches.fdt</a>, </li> +<li><a href="org/apache/datasketches/filters/package-tree.html">org.apache.datasketches.filters</a>, </li> +<li><a href="org/apache/datasketches/filters/bloomfilter/package-tree.html">org.apache.datasketches.filters.bloomfilter</a>, </li> +<li><a href="org/apache/datasketches/frequencies/package-tree.html">org.apache.datasketches.frequencies</a>, </li> +<li><a href="org/apache/datasketches/hash/package-tree.html">org.apache.datasketches.hash</a>, </li> +<li><a href="org/apache/datasketches/hll/package-tree.html">org.apache.datasketches.hll</a>, </li> +<li><a href="org/apache/datasketches/hllmap/package-tree.html">org.apache.datasketches.hllmap</a>, </li> +<li><a href="org/apache/datasketches/kll/package-tree.html">org.apache.datasketches.kll</a>, </li> +<li><a href="org/apache/datasketches/partitions/package-tree.html">org.apache.datasketches.partitions</a>, </li> +<li><a href="org/apache/datasketches/quantiles/package-tree.html">org.apache.datasketches.quantiles</a>, </li> +<li><a href="org/apache/datasketches/quantilescommon/package-tree.html">org.apache.datasketches.quantilescommon</a>, </li> +<li><a href="org/apache/datasketches/req/package-tree.html">org.apache.datasketches.req</a>, </li> +<li><a href="org/apache/datasketches/sampling/package-tree.html">org.apache.datasketches.sampling</a>, </li> +<li><a href="org/apache/datasketches/tdigest/package-tree.html">org.apache.datasketches.tdigest</a>, </li> +<li><a href="org/apache/datasketches/theta/package-tree.html">org.apache.datasketches.theta</a>, </li> +<li><a href="org/apache/datasketches/thetacommon/package-tree.html">org.apache.datasketches.thetacommon</a>, </li> +<li><a href="org/apache/datasketches/tuple/package-tree.html">org.apache.datasketches.tuple</a>, </li> +<li><a href="org/apache/datasketches/tuple/adouble/package-tree.html">org.apache.datasketches.tuple.adouble</a>, </li> +<li><a href="org/apache/datasketches/tuple/aninteger/package-tree.html">org.apache.datasketches.tuple.aninteger</a>, </li> +<li><a href="org/apache/datasketches/tuple/arrayofdoubles/package-tree.html">org.apache.datasketches.tuple.arrayofdoubles</a>, </li> +<li><a href="org/apache/datasketches/tuple/strings/package-tree.html">org.apache.datasketches.tuple.strings</a></li> +</ul> +</div> +<section class="hierarchy"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/AnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple">AnotB</a><S></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfItemsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfItemsSerDe</a><T> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfBooleansSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfBooleansSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfDoublesSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfDoublesSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfLongsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfLongsSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfNumbersSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfNumbersSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfStringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfStringsSerDe</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ArrayOfUtf16StringsSerDe.html" class="type-name-link" title="class in org.apache.datasketches.common">ArrayOfUtf16StringsSerDe</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>)</li> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/BinarySearch.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></li> +<li class="circle">org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/BinarySearch.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">BinarySearch</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BinomialBoundsN.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/BitPacking.html" class="type-name-link" title="class in org.apache.datasketches.theta">BitPacking</a></li> +<li class="circle">org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></li> +<li class="circle">org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilterBuilder</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnBinomialProportions.html" class="type-name-link" title="class in org.apache.datasketches.common">BoundsOnBinomialProportions</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/BoundsOnRatiosInSampledSets.html" class="type-name-link" title="class in org.apache.datasketches.common">BoundsOnRatiosInSampledSets</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInThetaSketchedSets.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/BoundsOnRatiosInTupleSketchedSets.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ByteArrayUtil.html" class="type-name-link" title="class in org.apache.datasketches.common">ByteArrayUtil</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ClassicUtil.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ClassicUtil</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CompressionCharacterization.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcSketch.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcSketch</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcUnion.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcUnion</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/CpcWrapper.html" class="type-name-link" title="class in org.apache.datasketches.cpc">CpcWrapper</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/DeserializeResult.html" class="type-name-link" title="class in org.apache.datasketches.tuple">DeserializeResult</a><T></li> +<li class="circle">org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/DirectBitArrayR.html" class="type-name-link" title="class in org.apache.datasketches.filters.bloomfilter">DirectBitArrayR</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a>) +<ul> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a>)</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>)</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S>)</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Filter.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Filter</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericPartitionBoundaries</a><T></li> +<li class="circle">org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/Group.html" class="type-name-link" title="class in org.apache.datasketches.fdt">Group</a> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>)</li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/HashOperations.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">HashOperations</a></li> +<li class="circle">org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/HllSketch.html" class="type-name-link" title="class in org.apache.datasketches.hll">HllSketch</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.DoublesPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.DoublesPair</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.FloatsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.FloatsPair</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.ItemsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.ItemsPair</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/IncludeMinMax.LongsPair.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">IncludeMinMax.LongsPair</a></li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>)</li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a> (implements org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S>)</li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Intersection.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Intersection</a><S></li> +<li class="circle">org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><T> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T>)</li> +<li class="circle">org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><T> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>)</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><T> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a><T> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T>)</li> +<li class="circle">org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><T></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/JaccardSimilarity.html" class="type-name-link" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/JaccardSimilarity.html" class="type-name-link" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a>) +<ul> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketch</a><T> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketch</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a>)</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a>) +<ul> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllFloatsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllItemsSketchIterator</a><T> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T>)</li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllLongsSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.kll">KllLongsSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a>)</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/KolmogorovSmirnov.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">KolmogorovSmirnov</a></li> +<li class="circle">org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch</a></li> +<li class="circle">org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" class="type-name-link" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSketchSortedView.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSketchSortedView</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a>)</li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/MergingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">MergingValidation</a></li> +<li class="circle">org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3.html" class="type-name-link" title="class in org.apache.datasketches.hash">MurmurHash3</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)</li> +<li class="circle">org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" class="type-name-link" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></li> +<li class="circle">org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner</a><T,<wbr>S></li> +<li class="circle">org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a><T></li> +<li class="circle">org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" class="type-name-link" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a><T></li> +<li class="circle">org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/PostProcessor.html" class="type-name-link" title="class in org.apache.datasketches.fdt">PostProcessor</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/QuickMergingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/QuickSelect.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></li> +<li class="circle">org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketch</a></li> +<li class="circle">org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></li> +<li class="circle">org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.req">ReqSketchIterator</a> (implements org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a>)</li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><T></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" class="type-name-link" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.html" class="type-name-link" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperation.html" class="type-name-link" title="class in org.apache.datasketches.theta">SetOperation</a> (implements org.apache.datasketches.common.<a href="org/apache/datasketches/common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a>) +<ul> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/AnotB.html" class="type-name-link" title="class in org.apache.datasketches.theta">AnotB</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Intersection.html" class="type-name-link" title="class in org.apache.datasketches.theta">Intersection</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Union.html" class="type-name-link" title="class in org.apache.datasketches.theta">Union</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/SetOperationBuilder.html" class="type-name-link" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">Sketch</a> (implements org.apache.datasketches.common.<a href="org/apache/datasketches/common/MemoryStatus.html" title="interface in org.apache.datasketches.common">MemoryStatus</a>) +<ul> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">CompactSketch</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketch.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketch</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketch</a><S> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/CompactSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,<wbr>S> +<ul> +<li class="circle">org.apache.datasketches.tuple.strings.<a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a> +<ul> +<li class="circle">org.apache.datasketches.fdt.<a href="org/apache/datasketches/fdt/FdtSketch.html" class="type-name-link" title="class in org.apache.datasketches.fdt">FdtSketch</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" class="type-name-link" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></li> +</ul> +</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" class="type-name-link" title="class in org.apache.datasketches.theta">Sketches</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Sketches.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Sketches</a></li> +<li class="circle">org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/Sort.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">Sort</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedViewIterator.html" class="type-name-link" title="class in org.apache.datasketches.quantilescommon">LongsSortedViewIterator</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/StreamingValidation.html" class="type-name-link" title="class in org.apache.datasketches.cpc">StreamingValidation</a></li> +<li class="circle">org.apache.datasketches.tdigest.<a href="org/apache/datasketches/tdigest/TDigestDouble.html" class="type-name-link" title="class in org.apache.datasketches.tdigest">TDigestDouble</a></li> +<li class="circle">org.apache.datasketches.cpc.<a href="org/apache/datasketches/cpc/TestUtil.html" class="type-name-link" title="class in org.apache.datasketches.cpc">TestUtil</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/ThetaUtil.html" class="type-name-link" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></li> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" class="type-name-link external-link" title="class or interface in java.lang">Throwable</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" class="type-name-link external-link" title="class or interface in java.lang">Exception</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" class="type-name-link external-link" title="class or interface in java.lang">RuntimeException</a> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesException</a> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesArgumentException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesArgumentException</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesReadOnlyException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/SketchesStateException.html" class="type-name-link" title="class in org.apache.datasketches.common">SketchesStateException</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/TupleSketchIterator.html" class="type-name-link" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><S></li> +<li class="circle">org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" class="type-name-link" title="class in org.apache.datasketches.hll">Union</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Union.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Union</a><S></li> +<li class="circle">org.apache.datasketches.hllmap.<a href="org/apache/datasketches/hllmap/UniqueCountMap.html" class="type-name-link" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><U,<wbr>S></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" class="type-name-link" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/Util.html" class="type-name-link" title="class in org.apache.datasketches.common">Util</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Util.html" class="type-name-link" title="class in org.apache.datasketches.tuple">Util</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><T> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><T>)</li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.VarOptItemsIterator.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.VarOptItemsIterator</a> (implements java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><E>)</li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.WeightedSample.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSamples.WeightedSample</a></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><T></li> +<li class="circle">org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" class="type-name-link" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><T></li> +<li class="circle">org.apache.datasketches.hash.<a href="org/apache/datasketches/hash/XxHash.html" class="type-name-link" title="class in org.apache.datasketches.hash">XxHash</a></li> +</ul> +</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html" class="type-name-link" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></li> +<li class="circle">org.apache.datasketches.tuple.arrayofdoubles.<a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/HashIterator.html" class="type-name-link" title="interface in org.apache.datasketches.theta">HashIterator</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/MemoryStatus.html" class="type-name-link" title="interface in org.apache.datasketches.common">MemoryStatus</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>, org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a>, org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>)</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsAPI</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesFloatsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a><T></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesLongsSketchIterator.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesLongsSketchIterator</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqDebug.html" class="type-name-link" title="interface in org.apache.datasketches.req">ReqDebug</a></li> +<li class="circle">org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/SketchFillRequest.html" class="type-name-link" title="interface in org.apache.datasketches.partitions">SketchFillRequest</a><T,<wbr>S></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a>)</li> +</ul> +</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">SortedView</a> +<ul> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/DoublesSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a><T> (also extends org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a><T>, org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>)</li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/LongsSortedView.html" class="type-name-link" title="interface in org.apache.datasketches.quantilescommon">LongsSortedView</a></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/Summary.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">Summary</a> +<ul> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/UpdatableSummary.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U></li> +</ul> +</li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummaryFactory.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SummarySetOperations.html" class="type-name-link" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S></li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Annotation Interface Hierarchy">Annotation Interface Hierarchy</h2> +<ul> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/SuppressFBWarnings.html" class="type-name-link" title="annotation interface in org.apache.datasketches.common">SuppressFBWarnings</a> (implements java.lang.annotation.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Annotation.html" title="class or interface in java.lang.annotation" class="external-link">Annotation</a>)</li> +</ul> +</section> +<section class="hierarchy"> +<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> +<ul> +<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) +<ul> +<li class="circle">org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" class="type-name-link" title="enum class in org.apache.datasketches.partitions">BoundsRule</a></li> +<li class="circle">org.apache.datasketches.tuple.adouble.<a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></li> +<li class="circle">org.apache.datasketches.frequencies.<a href="org/apache/datasketches/frequencies/ErrorType.html" class="type-name-link" title="enum class in org.apache.datasketches.frequencies">ErrorType</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" class="type-name-link" title="enum class in org.apache.datasketches.common">Family</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericInequalitySearch.Inequality.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/InequalitySearch.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">InequalitySearch</a></li> +<li class="circle">org.apache.datasketches.tuple.aninteger.<a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchStructure.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchStructure</a></li> +<li class="circle">org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.kll">KllSketch.SketchType</a></li> +<li class="circle">org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" class="type-name-link" title="enum class in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></li> +<li class="circle">org.apache.datasketches.common.<a href="org/apache/datasketches/common/ResizeFactor.html" class="type-name-link" title="enum class in org.apache.datasketches.common">ResizeFactor</a></li> +<li class="circle">org.apache.datasketches.tuple.<a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" class="type-name-link" title="enum class in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.AnotbAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.CornerCase.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.IntersectAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></li> +<li class="circle">org.apache.datasketches.thetacommon.<a href="org/apache/datasketches/thetacommon/SetOperationCornerCases.UnionAction.html" class="type-name-link" title="enum class in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></li> +<li class="circle">org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/TgtHllType.html" class="type-name-link" title="enum class in org.apache.datasketches.hll">TgtHllType</a></li> +<li class="circle">org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateReturnState.html" class="type-name-link" title="enum class in org.apache.datasketches.theta">UpdateReturnState</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</section> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/package-search-index.js b/docs/7.0.X/package-search-index.js new file mode 100644 index 000000000..f31308e56 --- /dev/null +++ b/docs/7.0.X/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"org.apache.datasketches"},{"l":"org.apache.datasketches.common"},{"l":"org.apache.datasketches.cpc"},{"l":"org.apache.datasketches.fdt"},{"l":"org.apache.datasketches.filters"},{"l":"org.apache.datasketches.filters.bloomfilter"},{"l":"org.apache.datasketches.frequencies"},{"l":"org.apache.datasketches.hash"},{"l":"org.apache.datasketches.hll"},{"l":"org.apache.datasketches.hllmap"},{"l":"org.apache.datasketches.kll"},{"l":"org.apache.datasketches.partitions"},{"l":"org.apache.datasketches.quantiles"},{"l":"org.apache.datasketches.quantilescommon"},{"l":"org.apache.datasketches.req"},{"l":"org.apache.datasketches.sampling"},{"l":"org.apache.datasketches.tdigest"},{"l":"org.apache.datasketches.theta"},{"l":"org.apache.datasketches.thetacommon"},{"l":"org.apache.datasketches.tuple"},{"l":"org.apache.datasketches.tuple.adouble"},{"l":"org.apache.datasketches.tuple.aninteger"},{"l":"org.apache.datasketches.tuple.arrayofdoubles"},{"l":"org.apache.datasketches.tuple.strings"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/7.0.X/resources/dictionary.html b/docs/7.0.X/resources/dictionary.html new file mode 100644 index 000000000..55bafe089 --- /dev/null +++ b/docs/7.0.X/resources/dictionary.html @@ -0,0 +1,282 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "https://www.w3.org/TR/html4/frameset.dtd"> + +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<html> +<head> +<title>Sketch Library Dictionary</title> +</head> +<body> +<h2>Sketch Library Dictionary</h2> + +<h3><a name="accuracy">Sketch Accuracy</a></h3> +Refers to sketch accuracy... + +<h3><a name="alphaTCF">Alpha TCF</a></h3> +The Alpha Theta Choosing Function (TCF) and the theory behind it is fully described in the +<a href="https://github.com/apache/datasketches-website/blob/master/docs/pdf/ThetaSketchFramework.pdf">Theta Sketch Framework</a> paper. +The alpha algorithm is optimized for speed and accuracy in a real-time sketch +building / estimating environment. +<p>One of the properties of the Alpha Algorithm used for cache management within a sketch is that +the value of <a href="#thetaLong">Theta Long</a> is always up-to-date. There may be +<a href="#dirtyHash">dirty hash</a> +values in the cache, but the Alpha Algorithm estimation function ignores them.</p> + +<h3><a name="defaultNomEntries">Default Nominal Entries</a></h3> +In Theta Sketches, the default nominal entries of 4096 is provided as a convenience for those cases where the +number of entries is not provided. +A sketch of 4096 entries has a Relative Standard Error (RSE) of +/- 1.56% at a confidence of 68%; +or equivalently, a Relative Error of +/- 3.1% at a confidence of 95.4%. + +<h3><a name="defaultUpdateSeed">Default Update Seed</a></h3> +<p>In Theta Sketches, the default <a href="#seed">Update Hash Seed</a> 9001 is a prime number that was chosen +very early on in experimental testing. +Choosing a seed is somewhat arbitrary, and this particular seed is not superior to other seeds. +<p>In performing set operations on two sketches it is critical that the same hash +function and seed was used for both sketches, otherwise the assumed 1:1 relationship +between the original source key value and the hashed bit string would be violated. +Once you have developed a history of stored sketches you are stuck with your chosen seed. +So don't change it! +<a href="#seed">Update Hash Seed</a> + +<h3><a name="degenerateSketch">Degenerate Sketch</a></h3> +A sketch is considered <i>degenerate</i> if it has never reached reached +<a href="#estMode">Estimation Mode</a> where the count of its retained hash values is +exact and less than <a href="#nomEntries">Nominal Entries</a> (or <i>k</i> entries) +and no estimation is needed. This is also referred to as <i>Exact Mode</i>. + +<h3><a name="dstMem">Destination Memory</a></h3> +The destination Memory for this object. If not required it may be null. If not null and large +enough the returned object will be backed by this Memory. +If null, the returned object will be on the Java heap. + +<h3><a name="dstOrdered">Destination Ordered</a></h3> +In Theta Sketches, this refers to the ordering of hash values in a returned CompactSketch. +If true, the internal hash values will be ordered. This will enable much higher +performance during union (merge) operations but at the cost of a sort, which may not be +desirable in some applications, especially real-time. + +<h3><a name="dirtyHash">Dirty Hash</a></h3> +For the Theta Alpha Sketch, a retained hash value is considered <i>dirty</i> if it is ≥ <a href="#thetaLong">Theta Long</a> or < 0. +See <a href="#validHash">Valid Hash</a>. + +<h3><a name="empty">isEmpty()</a></h3> +In Theta Sketches, the state <i>isEmpty()</i> for a sketch means that the sketch cache has zero hash values and that none of the +update methods have been called with valid data. In other words, the sketch has never seen any data. +This state is equivalent to "null" in the sense that it is safe to exclude empty sketches from union operations. However, an empty sketch +will impact intersections and difference set operations. + +<p>Note that <i>isEmpty()</i> does not always mean that theta is 1.0 because if <i>p</i> < 1.0, theta will be set +equal to <i>p</i> during construction. +Also, a cache of zero values (<i>getRetainedEntries(true) = 0</i>) does not mean that the sketch is <i>Empty</i> since +set intersection or difference operations can result in a sketch with zero values. +If the sourcing sketches had seen data then a resulting intersection or difference sketch will be <i>not Empty</i> +and have valid upper and lower bounds even if the cache has zero values. In other words, the resulting sketch represents +a valid distribution of data that just happens to have zero samples collected from it. + +<p>Note also that a virgin Intersection object will return <i>isEmpty() == false</i>. This is because a virgin Intersection object represents +the Universe Set, which is clearly not empty.</p> + +<p>These are subtle distinctions and exist for mathematical correctness. Excluding sketches that just have <i>getRetainedEntries(true) = 0</i> +from set operations them could result in impacting the accuracy of results. + +<h3><a name="estMode">Estimation Mode</a></h3> +Once a Theta Sketch exceeds the configured <a href="#nomEntries">Nominal Entries</a>, or <i>k</i>, number of retained hash values, +the sketch transitions into <i>estimation mode</i> where it must now estimate the population of uniques that +the retained entries represent. A sketch can also be in estimation mode if the sketch was configured with a +<a href="#p">Sampling Probability</a> < 1.0. +<i>Estimation Mode</i> = (<a href="#theta">θ</a> < 1.0) & NOT <i>empty</i>. + +<h3><a name="lgNomLongs">lgNomLongs</a></h3> +For Theta Sketches, the Log base 2 of the number of <a href="#nomEntries">Nominal Entries</a>. + +<h3><a name="lgArrLongs">lgArrLongs</a></h3> +For Theta Sketches, the Log base 2 of the size of the internal hash table in 64-bit longs. + +<h3><a name="mem">Memory</a></h3> +The backing Memory object which may be a source or destination. + +<h3><a name="nomEntries">Nominal Entries</a></h3> +For Theta Sketches and depending on the specific sketch, the constructor data type is <i>int</i> or <i>String</i>. +Acceptable values for constructing new sketches are positive integers that are powers of two. +This parameter specifies the target nominal number of entries (a.k.a. <i>k</i>) that will be retained in the internal cache +and ultimately determines the accuracy of the sketch (see <a href="#accuracy">Sketch Accuracy</a>). +Internally each entry is retained as a long of 8 bytes. + +<p>The reason it is called "nominal" is that depending on the specific algorithm of the sketch, the actual +number of entries retained by the sketch after the sketch goes into <i>estimation mode</i> +may differ from the configured value. For the <i>AlphaSketch</i> the number of retained entries statistically varies +but has a mean of <i>k</i>. For the <i>QuickSelect</i> sketches, the number of retained entries will statistically +vary from <i>k</i> to almost <i>2*k</i>. + +<p>Each sketch type also has a minimum acceptable value for this value. For QuickSelect Sketches this value is 16 and for +Alpha Sketches this value is 512. Specifying a value less than this minimum value just results in the minimum value being used. + +<h3><a name="numStdDev">Number of Standard Deviations</a></h3> +This is a positive number, which may be either an integer (1, 2, or 3) or a double ≤ 3.0. +This value is used in the getUpperBounds(int numStdDev) and +getLowerBounds(int numStdDev) methods and represents (theoretically) the +/- standard deviation from the center of the +Standard Normal Gaussian Distribution. For example: + +<p>getUpperBound(1) returns the estimated quantile(0.841) of the distribution.<br> +getLowerBound(1) returns the estimated quantile(0.158) of the distribution.<br> +getUpperBound(2) returns the estimated quantile(0.977) of the distribution.<br> +getLowerBound(2) returns the estimated quantile(0.023) of the distribution.<br> +getUpperBound(3) returns the estimated quantile(0.9986) of the distribution.<br> +getLowerBound(3) returns the estimated quantile(0.0013) of the distribution.<br> +</p> + +<p>However, for sketches with small configured values of <i>Nominal Entries < 4096</i> for Theta or <i>lgConfigK < 12</i> for HLL, +the error distribution of the sketch becomes quite asymmetric and cannot be approximated with a Gaussian. In these cases the interpretation of +<i>numStdDev</i> is that of an index that returns the quantile of the sketch error distribution that corresponds to fractional normalized rank +of the standard normal distribution at the specified <i>numStdDev</i>. + +<p>Thus, getUpperBound(1) and getLowerBound(2) represent the 68.3% confidence bounds, +getUpperBound(2) and getLowerBound(2) represent the 95.4% confidence bounds, and +getUpperBound(3) and getLowerBound(3) represent the 99.7% confidence bounds. +<br> + +<p>For some sketches where the error distribution is not Gaussian, special mathematical approximation methods are used. +See <a href="#accuracy">Sketch Accuracy</a>.</p> + + + +<h3><a name="quickSelectTCF">Quick Select TCF</a></h3> +The fundamental Theta Sketch QuickSelect algorithm is described in classic algorithm texts by Sedgewick and +is the Theta Choosing Function (<a href="#tcf">TCF</a>) for the QuickSelect Sketches. +When the internal hash table of the sketch reaches its internal +<i>refresh threshold</i>, +the quick select algorithm is used to select the <code>(k+1)th order statistic</code> +from the hash table with a complexity of <i>O(n)</i>. +The value of the selected hash becomes the new +<a href="#thetaLong">Theta Long</a> +and immediately makes some number of entries in the table +<a href="#dirtyHash">dirty</a>. +The <i>rebuild()</i> method is called that rebuilds the hash table removing the +<a href="#dirtyHash">dirty</a> values. +Since the value of <a href="#thetaLong">Theta Long</a> +is only changed when the hash table needs to be rebuilt, +the values in the hash table are only ever <a href="#dirtyHash">dirty</a> +briefly during the rebuild process. +Thus, all the values in the hash table are always +<a href="#validHash">valid</a> during normal updating of the sketch. +<p>One of the benefits of using the QuickSelect algorithm for the cache management of the sketch is +that the number of <a href="#validHash">valid</a> hashes ranges from +<a href="#nomEntries">nominal entries</a> +to the current <i>REBUILD_THRESHOLD</i></a>, which is nominally 15/16 * <i>cacheSize</i>. +This means that without the user forcing +a <i>rebuild()</i>, the sketch, on average, may be about 50% larger than +<a href="#nomEntries">nominal entries</a>, about 19% more accurate, and faster.</p> + +<h3><a name="resizeFactor">Resize Factor</a></h3> +For Theta Sketches, the Resize Factor is a dynamic, speed performance vs. memory size tradeoff. +The sketches created on-heap and configured with a Resize Factor of > X1 start out with +an internal hash table size that is the smallest submultiple of the the target +<a href="#nomEntries">Nominal Entries</a> +and larger than the minimum required hash table size for that sketch. +When the sketch needs to be resized larger, then the Resize Factor is used as a multiplier of +the current sketch cache array size. <br> +"X1" means no resizing is allowed and the sketch will be intialized at full size.<br> +"X2" means the internal cache will start very small and double in size until the target size is reached.<br> +Similarly, "X4" is a factor of 4 and "X8 is a factor of 8. + +<h3><a name="p">Sampling Probability <i>p</i></a></h3> +For Theta Sketches, the uniform random pre-sketching sampling probability. +Depending on the specific sketch, the constructor data type is <i>float</i> or <i>String</i>. +Incoming hashed data values are sampled by this probability factor before being submitted to +the sketching algorithm. For example, if <i>p</i> were set to 0.25, then on average, only one +forth of the incoming values, selected uniformly and at random, would be evaluated by the +sketching algorithm to be retained by the sketch. +Its default value is 1.0 (no sampling). +Its value must be in the range: 0 < p ≤ 1.0. +<p>This mode is particularly useful when merging large numbers of +<a href="#degenerateSketch">degenerate sketches</a>. + +<h3><a name="seed">Seed</a></h3> +For Theta Sketches, the long (64-bit) seed is required by the Update Hash Function. +This seed value is intentionally not serialized along with this sketch in order to provide +some security and protection against "dictionary attacks". +<p>In order to provide some protection against accidental mixing +of sketches that were generated with different seeds a short, 16-bit, +<a href="#seedHash">Seed Hash</a> is stored with the sketch image. +When heapifying or wrapping an UpdateSketch image, which can be either a byte array or a Memory object, +the user must provide the original seed either directly or indirectly by assuming the <a href="#defaultUpdateSeed">DEFAULT_UPDATE_SEED</a>. +The provided seed will be hashed and validated against the internal short Seed Hash and an error will be thrown if the seed hashes do not match. +The Set Operations classes, Union, Intersection and AnotB also require the user to provide the seed either directly or indirectly. +<p>An internal check will be made to make sure that the provided seed does not hash to a 16-bit value of zero. +If it does produce zero, an error will be thrown and the user must provide a different seed value. +<br> +See also <a href="#defaultUpdateSeed">Default Update Seed</a>. + +<h3><a name="seedHash">Seed Hash</a></h3> +For Theta and Tuple Sketches, a 16-bit hash of the <a href="#seed">Update Hash Seed</a> used internally to validate +(1) that two sketches undergoing set operations were, in fact, created using matching <a href="#seed">Update Hash Seeds</a>; +or (2) that when deserializing or wrapping a sketch image that the caller has the correct seed. + +<h3><a name="SnowPlow">Snow Plow Effect</a></h3> +When coordinated hash tables are merged and if the merging process does not update the target sketch with sufficient randomness, clustering +in the target hash table can be greatly exaggerated causing poor speed performance for both updates and searches. This is called the +"snowplow" effect because of the analogy of visualizing the clusters in a hash table as piles of snow that grow larger and larger. Since the +size of the clusters are only represented by their width (not height like piles of snow), the clusters push themselves out horizontally and +merge together as if they were pushed together with a snowplow. + +<h3><a name="tcf">Theta Choosing Function (TCF)</a></h3> +For Theta Sketches, the Theta Choosing Function (TCF) and the theory behind it is fully described in the +<a href="https://github.com/apache/datasketches-website/blob/master/docs/pdf/ThetaSketchFramework.pdf">Theta Sketch Framework</a> paper. + +<h3><a name="theta">Theta, θ</a></h3> +For Theta Sketches, refers to the mathematical random variable θ that represents the current probability +that the next, non-duplicate unique input value presented to the sketch will change the state of the sketch. +Given <i>N</i> uniquified inputs to a sketch configured to retain at most <i>k</i> hashes of the inputs, +<code>θ ≈ <i>k/N</i>, 0 < θ ≤ 1.0</code>, and θ = (double) thetaLong / Long.MAX_VALUE;. +See <a href="#thetaLong">thetaLong</a>. + +<h3><a name="thetaLong">thetaLong</a></h3> +For Theta Sketches, the 64-bit, positive <i>long</i> equivalent of <a href="#theta">theta</a> where<br> +0 < <i>thetaLong</i> ≤ <i>Long.MAX_VALUE</i>, and <i>thetaLong</i> = θ * Long.MAX_VALUE. + +<h3><a name="thetaSketch">Theta Sketch Framework</a></h3> +This framework enables sketches with different algorithms and Theta Choosing Functions +to be arguments to the Union, Intersection and AnotB Set Operations. +This framework also enables the sketches to share estimation, upper and lower bounds algorithms and +a common serialization data structure. +The Theta Sketch Framework, Theta Choosing Functions and the theory behind them is fully described +in the <a href="https://github.com/apache/datasketches-website/blob/master/docs/pdf/ThetaSketchFramework.pdf">Theta Sketch Framework</a> paper. + +<h3><a name="updateReturnState">Update Return State</a></h3> +For Theta Sketches, this provides useful detail for sketch characterization and debugging. It is not required that any of +these values be monitored during normal operation. +The UpdateReturnState is defined as follows: +<ul> +<li> InsertedCountIncremented: Inserted, not full, retained_entries_count incremented.</li> +<li> InsertedCountNotIncremented: Inserted, not full, retained-entries-count not incremented +because a dirty value was overridden.</li> +<li> RejectedDuplicate: Rejected as duplicate.</li> +<li> RejectedNullOrEmpty: Rejected because input was null or empty. Only for update objects.</li> +<li> RejectedOverTheta: Rejected because the computed hash was over the current value of thetaLong.</li> +</ul> + + +<h3><a name="validHash">Valid Hash</a></h3> +For Theta Sketches, a retained hash value is considered <i>valid</i> if it is greater than zero and less than +<a href="#thetaLong">thetaLong</a>. See <a href="#dirtyHash">Dirty Hash</a>. + +</body> +</html> \ No newline at end of file diff --git a/docs/7.0.X/resources/glass.png b/docs/7.0.X/resources/glass.png new file mode 100644 index 000000000..a7f591f46 Binary files /dev/null and b/docs/7.0.X/resources/glass.png differ diff --git a/docs/7.0.X/resources/x.png b/docs/7.0.X/resources/x.png new file mode 100644 index 000000000..30548a756 Binary files /dev/null and b/docs/7.0.X/resources/x.png differ diff --git a/docs/7.0.X/script-dir/jquery-3.7.1.min.js b/docs/7.0.X/script-dir/jquery-3.7.1.min.js new file mode 100644 index 000000000..7f37b5d99 --- /dev/null +++ b/docs/7.0.X/script-dir/jquery-3.7.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0<t&&t-1 in e)}function fe(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()}ce.fn=ce.prototype={jquery:t,constructor:ce,length:0,toArray:function(){return ae.call(this)},get:function(e){return null==e?ae.call(this):e<0?this[e+this.length]:this[e]},pushStack:function(e){var t=ce.merge(this.constructor(),e);return t.prevObject=this,t},each:function(e){return ce.each(this,e)},map:function(n){return this.pushStack(ce.map(this,function(e,t){return n.call(e,t,e)}))},slice:function(){return this.pushStack(ae.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},even:function(){return this.pushStack(ce.grep(this,function(e,t){return(t+1)%2}))},odd:function(){return this.pushStack(ce.grep(this,function(e,t){return t%2}))},eq:function(e){var t=this.length,n=+e+(e<0?t:0);return this.pushStack(0<=n&&n<t?[this[n]]:[])},end:function(){return this.prevObject||this.constructor()},push:s,sort:oe.sort,splice:oe.splice},ce.extend=ce.fn.extend=function(){var e,t,n,r,i,o,a=arguments[0]||{},s=1,u=arguments.length,l=!1;for("boolean"==typeof a&&(l=a,a=arguments[s]||{},s++),"object"==typeof a||v(a)||(a={}),s===u&&(a=this,s--);s<u;s++)if(null!=(e=arguments[s]))for(t in e)r=e[t],"__proto__"!==t&&a!==r&&(l&&r&&(ce.isPlainObject(r)||(i=Array.isArray(r)))?(n=a[t],o=i&&!Array.isArray(n)?[]:i||ce.isPlainObject(n)?n:{},i=!1,a[t]=ce.extend(l,o,r)):void 0!==r&&(a[t]=r));return a},ce.extend({expando:"jQuery"+(t+Math.random()).replace(/\D/g,""),isReady:!0,error:function(e){throw new Error(e)},noop:function(){},isPlainObject:function(e){var t,n;return!(!e||"[object Object]"!==i.call(e))&&(!(t=r(e))||"function"==typeof(n=ue.call(t,"constructor")&&t.constructor)&&o.call(n)===a)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},globalEval:function(e,t,n){m(e,{nonce:t&&t.nonce},n)},each:function(e,t){var n,r=0;if(c(e)){for(n=e.length;r<n;r++)if(!1===t.call(e[r],r,e[r]))break}else for(r in e)if(!1===t.call(e[r],r,e[r]))break;return e},text:function(e){var t,n="",r=0,i=e.nodeType;if(!i)while(t=e[r++])n+=ce.text(t);return 1===i||11===i?e.textContent:9===i?e.documentElement.textContent:3===i||4===i?e.nodeValue:n},makeArray:function(e,t){var n=t||[];return null!=e&&(c(Object(e))?ce.merge(n,"string"==typeof e?[e]:e):s.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:se.call(t,e,n)},isXMLDoc:function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!l.test(t||n&&n.nodeName||"HTML")},merge:function(e,t){for(var n=+t.length,r=0,i=e.length;r<n;r++)e[i++]=t[r];return e.length=i,e},grep:function(e,t,n){for(var r=[],i=0,o=e.length,a=!n;i<o;i++)!t(e[i],i)!==a&&r.push(e[i]);return r},map:function(e,t,n){var r,i,o=0,a=[];if(c(e))for(r=e.length;o<r;o++)null!=(i=t(e[o],o,n))&&a.push(i);else for(o in e)null!=(i=t(e[o],o,n))&&a.push(i);return g(a)},guid:1,support:le}),"function"==typeof Symbol&&(ce.fn[Symbol.iterator]=oe[Symbol.iterator]),ce.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(e,t){n["[object "+t+"]"]=t.toLowerCase()});var pe=oe.pop,de=oe.sort,he=oe.splice,ge="[\\x20\\t\\r\\n\\f]",ve=new RegExp("^"+ge+"+|((?:^|[^\\\\])(?:\\\\.)*)"+ge+"+$","g");ce.contains=function(e,t){var n=t&&t.parentNode;return e===n||!(!n||1!==n.nodeType||!(e.contains?e.contains(n):e.compareDocumentPosition&&16&e.compareDocumentPosition(n)))};var f=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\x80-\uFFFF\w-]/g;function p(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e}ce.escapeSelector=function(e){return(e+"").replace(f,p)};var ye=C,me=s;!function(){var e,b,w,o,a,T,r,C,d,i,k=me,S=ce.expando,E=0,n=0,s=W(),c=W(),u=W(),h=W(),l=function(e,t){return e===t&&(a=!0),0},f="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",t="(?:\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+",p="\\["+ge+"*("+t+")(?:"+ge+"*([*^$|!~]?=)"+ge+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+t+"))|)"+ge+"*\\]",g=":("+t+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+p+")*)|.*)\\)|)",v=new RegExp(ge+"+","g"),y=new RegExp("^"+ge+"*,"+ge+"*"),m=new RegExp("^"+ge+"*([>+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},M=function(){V()},R=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&U(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function z(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&R(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function X(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function U(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,r.msMatchesSelector&&ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",M),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="<a id='"+S+"' href='' disabled='disabled'></a><select id='"+S+"-\r\\' disabled='disabled'><option selected=''></option></select>",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0<I(t,T,null,[e]).length},I.contains=function(e,t){return(e.ownerDocument||e)!=T&&V(e),ce.contains(e,t)},I.attr=function(e,t){(e.ownerDocument||e)!=T&&V(e);var n=b.attrHandle[t.toLowerCase()],r=n&&ue.call(b.attrHandle,t.toLowerCase())?n(e,t,!C):void 0;return void 0!==r?r:e.getAttribute(t)},I.error=function(e){throw new Error("Syntax error, unrecognized expression: "+e)},ce.uniqueSort=function(e){var t,n=[],r=0,i=0;if(a=!le.sortStable,o=!le.sortStable&&ae.call(e,0),de.call(e,l),a){while(t=e[i++])t===e[i]&&(r=n.push(i));while(r--)he.call(e,n[r],1)}return o=null,e},ce.fn.uniqueSort=function(){return this.pushStack(ce.uniqueSort(ae.apply(this)))},(b=ce.expr={cacheLength:50,createPseudo:F,match:D,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1<t.indexOf(i):"$="===r?i&&t.slice(-i.length)===i:"~="===r?-1<(" "+t.replace(v," ")+" ").indexOf(i):"|="===r&&(t===i||t.slice(0,i.length+1)===i+"-"))}},CHILD:function(d,e,t,h,g){var v="nth"!==d.slice(0,3),y="last"!==d.slice(-4),m="of-type"===e;return 1===h&&0===g?function(e){return!!e.parentNode}:function(e,t,n){var r,i,o,a,s,u=v!==y?"nextSibling":"previousSibling",l=e.parentNode,c=m&&e.nodeName.toLowerCase(),f=!n&&!m,p=!1;if(l){if(v){while(u){o=e;while(o=o[u])if(m?fe(o,c):1===o.nodeType)return!1;s=u="only"===d&&!s&&"nextSibling"}return!0}if(s=[y?l.firstChild:l.lastChild],y&&f){p=(a=(r=(i=l[S]||(l[S]={}))[d]||[])[0]===E&&r[1])&&r[2],o=a&&l.childNodes[a];while(o=++a&&o&&o[u]||(p=a=0)||s.pop())if(1===o.nodeType&&++p&&o===e){i[d]=[E,a,p];break}}else if(f&&(p=a=(r=(i=e[S]||(e[S]={}))[d]||[])[0]===E&&r[1]),!1===p)while(o=++a&&o&&o[u]||(p=a=0)||s.pop())if((m?fe(o,c):1===o.nodeType)&&++p&&(f&&((i=o[S]||(o[S]={}))[d]=[E,p]),o===e))break;return(p-=g)===h||p%h==0&&0<=p/h}}},PSEUDO:function(e,o){var t,a=b.pseudos[e]||b.setFilters[e.toLowerCase()]||I.error("unsupported pseudo: "+e);return a[S]?a(o):1<a.length?(t=[e,e,"",o],b.setFilters.hasOwnProperty(e.toLowerCase())?F(function(e,t){var n,r=a(e,o),i=r.length;while(i--)e[n=se.call(e,r[i])]=!(t[n]=r[i])}):function(e){return a(e,0,t)}):a}},pseudos:{not:F(function(e){var r=[],i=[],s=ne(e.replace(ve,"$1"));return s[S]?F(function(e,t,n,r){var i,o=s(e,null,r,[]),a=e.length;while(a--)(i=o[a])&&(e[a]=!(t[a]=i))}):function(e,t,n){return r[0]=e,s(r,null,n,i),r[0]=null,!i.pop()}}),has:F(function(t){return function(e){return 0<I(t,e).length}}),contains:F(function(t){return t=t.replace(O,P),function(e){return-1<(e.textContent||ce.text(e)).indexOf(t)}}),lang:F(function(n){return A.test(n||"")||I.error("unsupported lang: "+n),n=n.replace(O,P).toLowerCase(),function(e){var t;do{if(t=C?e.lang:e.getAttribute("xml:lang")||e.getAttribute("lang"))return(t=t.toLowerCase())===n||0===t.indexOf(n+"-")}while((e=e.parentNode)&&1===e.nodeType);return!1}}),target:function(e){var t=ie.location&&ie.location.hash;return t&&t.slice(1)===e.id},root:function(e){return e===r},focus:function(e){return e===function(){try{return T.activeElement}catch(e){}}()&&T.hasFocus()&&!!(e.type||e.href||~e.tabIndex)},enabled:z(!1),disabled:z(!0),checked:function(e){return fe(e,"input")&&!!e.checked||fe(e,"option")&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,!0===e.selected},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeType<6)return!1;return!0},parent:function(e){return!b.pseudos.empty(e)},header:function(e){return q.test(e.nodeName)},input:function(e){return N.test(e.nodeName)},button:function(e){return fe(e,"input")&&"button"===e.type||fe(e,"button")},text:function(e){var t;return fe(e,"input")&&"text"===e.type&&(null==(t=e.getAttribute("type"))||"text"===t.toLowerCase())},first:X(function(){return[0]}),last:X(function(e,t){return[t-1]}),eq:X(function(e,t,n){return[n<0?n+t:n]}),even:X(function(e,t){for(var n=0;n<t;n+=2)e.push(n);return e}),odd:X(function(e,t){for(var n=1;n<t;n+=2)e.push(n);return e}),lt:X(function(e,t,n){var r;for(r=n<0?n+t:t<n?t:n;0<=--r;)e.push(r);return e}),gt:X(function(e,t,n){for(var r=n<0?n+t:n;++r<t;)e.push(r);return e})}}).pseudos.nth=b.pseudos.eq,{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})b.pseudos[e]=B(e);for(e in{submit:!0,reset:!0})b.pseudos[e]=_(e);function G(){}function Y(e,t){var n,r,i,o,a,s,u,l=c[e+" "];if(l)return t?0:l.slice(0);a=e,s=[],u=b.preFilter;while(a){for(o in n&&!(r=y.exec(a))||(r&&(a=a.slice(r[0].length)||a),s.push(i=[])),n=!1,(r=m.exec(a))&&(n=r.shift(),i.push({value:n,type:r[0].replace(ve," ")}),a=a.slice(n.length)),b.filter)!(r=D[o].exec(a))||u[o]&&!(r=u[o](r))||(n=r.shift(),i.push({value:n,type:o,matches:r}),a=a.slice(n.length));if(!n)break}return t?a.length:a?I.error(e):c(e,s).slice(0)}function Q(e){for(var t=0,n=e.length,r="";t<n;t++)r+=e[t].value;return r}function J(a,e,t){var s=e.dir,u=e.next,l=u||s,c=t&&"parentNode"===l,f=n++;return e.first?function(e,t,n){while(e=e[s])if(1===e.nodeType||c)return a(e,t,n);return!1}:function(e,t,n){var r,i,o=[E,f];if(n){while(e=e[s])if((1===e.nodeType||c)&&a(e,t,n))return!0}else while(e=e[s])if(1===e.nodeType||c)if(i=e[S]||(e[S]={}),u&&fe(e,u))e=e[s]||e;else{if((r=i[l])&&r[0]===E&&r[1]===f)return o[2]=r[2];if((i[l]=o)[2]=a(e,t,n))return!0}return!1}}function K(i){return 1<i.length?function(e,t,n){var r=i.length;while(r--)if(!i[r](e,t,n))return!1;return!0}:i[0]}function Z(e,t,n,r,i){for(var o,a=[],s=0,u=e.length,l=null!=t;s<u;s++)(o=e[s])&&(n&&!n(o,r,i)||(a.push(o),l&&t.push(s)));return a}function ee(d,h,g,v,y,e){return v&&!v[S]&&(v=ee(v)),y&&!y[S]&&(y=ee(y,e)),F(function(e,t,n,r){var i,o,a,s,u=[],l=[],c=t.length,f=e||function(e,t,n){for(var r=0,i=t.length;r<i;r++)I(e,t[r],n);return n}(h||"*",n.nodeType?[n]:n,[]),p=!d||!e&&h?f:Z(f,u,d,n,r);if(g?g(p,s=y||(e?d:c||v)?[]:t,n,r):s=p,v){i=Z(s,l),v(i,[],n,r),o=i.length;while(o--)(a=i[o])&&(s[l[o]]=!(p[l[o]]=a))}if(e){if(y||d){if(y){i=[],o=s.length;while(o--)(a=s[o])&&i.push(p[o]=a);y(null,s=[],i,r)}o=s.length;while(o--)(a=s[o])&&-1<(i=y?se.call(e,a):u[o])&&(e[i]=!(t[i]=a))}}else s=Z(s===t?s.splice(c,s.length):s),y?y(null,t,s,r):k.apply(t,s)})}function te(e){for(var i,t,n,r=e.length,o=b.relative[e[0].type],a=o||b.relative[" "],s=o?1:0,u=J(function(e){return e===i},a,!0),l=J(function(e){return-1<se.call(i,e)},a,!0),c=[function(e,t,n){var r=!o&&(n||t!=w)||((i=t).nodeType?u(e,t,n):l(e,t,n));return i=null,r}];s<r;s++)if(t=b.relative[e[s].type])c=[J(K(c),t)];else{if((t=b.filter[e[s].type].apply(null,e[s].matches))[S]){for(n=++s;n<r;n++)if(b.relative[e[n].type])break;return ee(1<s&&K(c),1<s&&Q(e.slice(0,s-1).concat({value:" "===e[s-2].type?"*":""})).replace(ve,"$1"),t,s<n&&te(e.slice(s,n)),n<r&&te(e=e.slice(n)),n<r&&Q(e))}c.push(t)}return K(c)}function ne(e,t){var n,v,y,m,x,r,i=[],o=[],a=u[e+" "];if(!a){t||(t=Y(e)),n=t.length;while(n--)(a=te(t[n]))[S]?i.push(a):o.push(a);(a=u(e,(v=o,m=0<(y=i).length,x=0<v.length,r=function(e,t,n,r,i){var o,a,s,u=0,l="0",c=e&&[],f=[],p=w,d=e||x&&b.find.TAG("*",i),h=E+=null==p?1:Math.random()||.1,g=d.length;for(i&&(w=t==T||t||i);l!==g&&null!=(o=d[l]);l++){if(x&&o){a=0,t||o.ownerDocument==T||(V(o),n=!C);while(s=v[a++])if(s(o,t||T,n)){k.call(r,o);break}i&&(E=h)}m&&((o=!s&&o)&&u--,e&&c.push(o))}if(u+=l,m&&l!==u){a=0;while(s=y[a++])s(c,f,t,n);if(e){if(0<u)while(l--)c[l]||f[l]||(f[l]=pe.call(r));f=Z(f)}k.apply(r,f),i&&!e&&0<f.length&&1<u+y.length&&ce.uniqueSort(r)}return i&&(E=h,w=p),c},m?F(r):r))).selector=e}return a}function re(e,t,n,r){var i,o,a,s,u,l="function"==typeof e&&e,c=!r&&Y(e=l.selector||e);if(n=n||[],1===c.length){if(2<(o=c[0]=c[0].slice(0)).length&&"ID"===(a=o[0]).type&&9===t.nodeType&&C&&b.relative[o[1].type]){if(!(t=(b.find.ID(a.matches[0].replace(O,P),t)||[])[0]))return n;l&&(t=t.parentNode),e=e.slice(o.shift().value.length)}i=D.needsContext.test(e)?0:o.length;while(i--){if(a=o[i],b.relative[s=a.type])break;if((u=b.find[s])&&(r=u(a.matches[0].replace(O,P),H.test(o[0].type)&&U(t.parentNode)||t))){if(o.splice(i,1),!(e=r.length&&Q(o)))return k.apply(n,r),n;break}}}return(l||ne(e,c))(r,t,!C,n,!t||H.test(e)&&U(t.parentNode)||t),n}G.prototype=b.filters=b.pseudos,b.setFilters=new G,le.sortStable=S.split("").sort(l).join("")===S,V(),le.sortDetached=$(function(e){return 1&e.compareDocumentPosition(T.createElement("fieldset"))}),ce.find=I,ce.expr[":"]=ce.expr.pseudos,ce.unique=ce.uniqueSort,I.compile=ne,I.select=re,I.setDocument=V,I.tokenize=Y,I.escape=ce.escapeSelector,I.getText=ce.text,I.isXML=ce.isXMLDoc,I.selectors=ce.expr,I.support=ce.support,I.uniqueSort=ce.uniqueSort}();var d=function(e,t,n){var r=[],i=void 0!==n;while((e=e[t])&&9!==e.nodeType)if(1===e.nodeType){if(i&&ce(e).is(n))break;r.push(e)}return r},h=function(e,t){for(var n=[];e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n},b=ce.expr.match.needsContext,w=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1<se.call(n,e)!==r}):ce.filter(n,e,r)}ce.filter=function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?ce.find.matchesSelector(r,e)?[r]:[]:ce.find.matches(e,ce.grep(t,function(e){return 1===e.nodeType}))},ce.fn.extend({find:function(e){var t,n,r=this.length,i=this;if("string"!=typeof e)return this.pushStack(ce(e).filter(function(){for(t=0;t<r;t++)if(ce.contains(i[t],this))return!0}));for(n=this.pushStack([]),t=0;t<r;t++)ce.find(e,i[t],n);return 1<r?ce.uniqueSort(n):n},filter:function(e){return this.pushStack(T(this,e||[],!1))},not:function(e){return this.pushStack(T(this,e||[],!0))},is:function(e){return!!T(this,"string"==typeof e&&b.test(e)?ce(e):e||[],!1).length}});var k,S=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e<n;e++)if(ce.contains(this,t[e]))return!0})},closest:function(e,t){var n,r=0,i=this.length,o=[],a="string"!=typeof e&&ce(e);if(!b.test(e))for(;r<i;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(n.nodeType<11&&(a?-1<a.index(n):1===n.nodeType&&ce.find.matchesSelector(n,e))){o.push(n);break}return this.pushStack(1<o.length?ce.uniqueSort(o):o)},index:function(e){return e?"string"==typeof e?se.call(ce(e),this[0]):se.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){return this.pushStack(ce.uniqueSort(ce.merge(this.get(),ce(e,t))))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}}),ce.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return d(e,"parentNode")},parentsUntil:function(e,t,n){return d(e,"parentNode",n)},next:function(e){return A(e,"nextSibling")},prev:function(e){return A(e,"previousSibling")},nextAll:function(e){return d(e,"nextSibling")},prevAll:function(e){return d(e,"previousSibling")},nextUntil:function(e,t,n){return d(e,"nextSibling",n)},prevUntil:function(e,t,n){return d(e,"previousSibling",n)},siblings:function(e){return h((e.parentNode||{}).firstChild,e)},children:function(e){return h(e.firstChild)},contents:function(e){return null!=e.contentDocument&&r(e.contentDocument)?e.contentDocument:(fe(e,"template")&&(e=e.content||e),ce.merge([],e.childNodes))}},function(r,i){ce.fn[r]=function(e,t){var n=ce.map(this,i,e);return"Until"!==r.slice(-5)&&(t=e),t&&"string"==typeof t&&(n=ce.filter(t,n)),1<this.length&&(j[r]||ce.uniqueSort(n),E.test(r)&&n.reverse()),this.pushStack(n)}});var D=/[^\x20\t\r\n\f]+/g;function N(e){return e}function q(e){throw e}function L(e,t,n,r){var i;try{e&&v(i=e.promise)?i.call(e).done(t).fail(n):e&&v(i=e.then)?i.call(e,t,n):t.apply(void 0,[e].slice(r))}catch(e){n.apply(void 0,[e])}}ce.Callbacks=function(r){var e,n;r="string"==typeof r?(e=r,n={},ce.each(e.match(D)||[],function(e,t){n[t]=!0}),n):ce.extend({},r);var i,t,o,a,s=[],u=[],l=-1,c=function(){for(a=a||r.once,o=i=!0;u.length;l=-1){t=u.shift();while(++l<s.length)!1===s[l].apply(t[0],t[1])&&r.stopOnFalse&&(l=s.length,t=!1)}r.memory||(t=!1),i=!1,a&&(s=t?[]:"")},f={add:function(){return s&&(t&&!i&&(l=s.length-1,u.push(t)),function n(e){ce.each(e,function(e,t){v(t)?r.unique&&f.has(t)||s.push(t):t&&t.length&&"string"!==x(t)&&n(t)})}(arguments),t&&!i&&c()),this},remove:function(){return ce.each(arguments,function(e,t){var n;while(-1<(n=ce.inArray(t,s,n)))s.splice(n,1),n<=l&&l--}),this},has:function(e){return e?-1<ce.inArray(e,s):0<s.length},empty:function(){return s&&(s=[]),this},disable:function(){return a=u=[],s=t="",this},disabled:function(){return!s},lock:function(){return a=u=[],t||i||(s=t=""),this},locked:function(){return!!a},fireWith:function(e,t){return a||(t=[e,(t=t||[]).slice?t.slice():t],u.push(t),i||c()),this},fire:function(){return f.fireWith(this,arguments),this},fired:function(){return!!o}};return f},ce.extend({Deferred:function(e){var o=[["notify","progress",ce.Callbacks("memory"),ce.Callbacks("memory"),2],["resolve","done",ce.Callbacks("once memory"),ce.Callbacks("once memory"),0,"resolved"],["reject","fail",ce.Callbacks("once memory"),ce.Callbacks("once memory"),1,"rejected"]],i="pending",a={state:function(){return i},always:function(){return s.done(arguments).fail(arguments),this},"catch":function(e){return a.then(null,e)},pipe:function(){var i=arguments;return ce.Deferred(function(r){ce.each(o,function(e,t){var n=v(i[t[4]])&&i[t[4]];s[t[1]](function(){var e=n&&n.apply(this,arguments);e&&v(e.promise)?e.promise().progress(r.notify).done(r.resolve).fail(r.reject):r[t[0]+"With"](this,n?[e]:arguments)})}),i=null}).promise()},then:function(t,n,r){var u=0;function l(i,o,a,s){return function(){var n=this,r=arguments,e=function(){var e,t;if(!(i<u)){if((e=a.apply(n,r))===o.promise())throw new TypeError("Thenable self-resolution");t=e&&("object"==typeof e||"function"==typeof e)&&e.then,v(t)?s?t.call(e,l(u,o,N,s),l(u,o,q,s)):(u++,t.call(e,l(u,o,N,s),l(u,o,q,s),l(u,o,N,o.notifyWith))):(a!==N&&(n=void 0,r=[e]),(s||o.resolveWith)(n,r))}},t=s?e:function(){try{e()}catch(e){ce.Deferred.exceptionHook&&ce.Deferred.exceptionHook(e,t.error),u<=i+1&&(a!==q&&(n=void 0,r=[e]),o.rejectWith(n,r))}};i?t():(ce.Deferred.getErrorHook?t.error=ce.Deferred.getErrorHook():ce.Deferred.getStackHook&&(t.error=ce.Deferred.getStackHook()),ie.setTimeout(t))}}return ce.Deferred(function(e){o[0][3].add(l(0,e,v(r)?r:N,e.notifyWith)),o[1][3].add(l(0,e,v(t)?t:N)),o[2][3].add(l(0,e,v(n)?n:q))}).promise()},promise:function(e){return null!=e?ce.extend(e,a):a}},s={};return ce.each(o,function(e,t){var n=t[2],r=t[5];a[t[1]]=n.add,r&&n.add(function(){i=r},o[3-e][2].disable,o[3-e][3].disable,o[0][2].lock,o[0][3].lock),n.add(t[3].fire),s[t[0]]=function(){return s[t[0]+"With"](this===s?void 0:this,arguments),this},s[t[0]+"With"]=n.fireWith}),a.promise(s),e&&e.call(s,s),s},when:function(e){var n=arguments.length,t=n,r=Array(t),i=ae.call(arguments),o=ce.Deferred(),a=function(t){return function(e){r[t]=this,i[t]=1<arguments.length?ae.call(arguments):e,--n||o.resolveWith(r,i)}};if(n<=1&&(L(e,o.done(a(t)).resolve,o.reject,!n),"pending"===o.state()||v(i[t]&&i[t].then)))return o.then();while(t--)L(i[t],a(t),o.reject);return o.promise()}});var H=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;ce.Deferred.exceptionHook=function(e,t){ie.console&&ie.console.warn&&e&&H.test(e.name)&&ie.console.warn("jQuery.Deferred exception: "+e.message,e.stack,t)},ce.readyException=function(e){ie.setTimeout(function(){throw e})};var O=ce.Deferred();function P(){C.removeEventListener("DOMContentLoaded",P),ie.removeEventListener("load",P),ce.ready()}ce.fn.ready=function(e){return O.then(e)["catch"](function(e){ce.readyException(e)}),this},ce.extend({isReady:!1,readyWait:1,ready:function(e){(!0===e?--ce.readyWait:ce.isReady)||(ce.isReady=!0)!==e&&0<--ce.readyWait||O.resolveWith(C,[ce])}}),ce.ready.then=O.then,"complete"===C.readyState||"loading"!==C.readyState&&!C.documentElement.doScroll?ie.setTimeout(ce.ready):(C.addEventListener("DOMContentLoaded",P),ie.addEventListener("load",P));var M=function(e,t,n,r,i,o,a){var s=0,u=e.length,l=null==n;if("object"===x(n))for(s in i=!0,n)M(e,t,s,n[s],!0,o,a);else if(void 0!==r&&(i=!0,v(r)||(a=!0),l&&(a?(t.call(e,r),t=null):(l=t,t=function(e,t,n){return l.call(ce(e),n)})),t))for(;s<u;s++)t(e[s],n,a?r:r.call(e[s],s,t(e[s],n)));return i?e:l?t.call(e):u?t(e[0],n):o},R=/^-ms-/,I=/-([a-z])/g;function W(e,t){return t.toUpperCase()}function F(e){return e.replace(R,"ms-").replace(I,W)}var $=function(e){return 1===e.nodeType||9===e.nodeType||!+e.nodeType};function B(){this.expando=ce.expando+B.uid++}B.uid=1,B.prototype={cache:function(e){var t=e[this.expando];return t||(t={},$(e)&&(e.nodeType?e[this.expando]=t:Object.defineProperty(e,this.expando,{value:t,configurable:!0}))),t},set:function(e,t,n){var r,i=this.cache(e);if("string"==typeof t)i[F(t)]=n;else for(r in t)i[F(r)]=t[r];return i},get:function(e,t){return void 0===t?this.cache(e):e[this.expando]&&e[this.expando][F(t)]},access:function(e,t,n){return void 0===t||t&&"string"==typeof t&&void 0===n?this.get(e,t):(this.set(e,t,n),void 0!==n?n:t)},remove:function(e,t){var n,r=e[this.expando];if(void 0!==r){if(void 0!==t){n=(t=Array.isArray(t)?t.map(F):(t=F(t))in r?[t]:t.match(D)||[]).length;while(n--)delete r[t[n]]}(void 0===t||ce.isEmptyObject(r))&&(e.nodeType?e[this.expando]=void 0:delete e[this.expando])}},hasData:function(e){var t=e[this.expando];return void 0!==t&&!ce.isEmptyObject(t)}};var _=new B,z=new B,X=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,U=/[A-Z]/g;function V(e,t,n){var r,i;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(U,"-$&").toLowerCase(),"string"==typeof(n=e.getAttribute(r))){try{n="true"===(i=n)||"false"!==i&&("null"===i?null:i===+i+""?+i:X.test(i)?JSON.parse(i):i)}catch(e){}z.set(e,t,n)}else n=void 0;return n}ce.extend({hasData:function(e){return z.hasData(e)||_.hasData(e)},data:function(e,t,n){return z.access(e,t,n)},removeData:function(e,t){z.remove(e,t)},_data:function(e,t,n){return _.access(e,t,n)},_removeData:function(e,t){_.remove(e,t)}}),ce.fn.extend({data:function(n,e){var t,r,i,o=this[0],a=o&&o.attributes;if(void 0===n){if(this.length&&(i=z.get(o),1===o.nodeType&&!_.get(o,"hasDataAttrs"))){t=a.length;while(t--)a[t]&&0===(r=a[t].name).indexOf("data-")&&(r=F(r.slice(5)),V(o,r,i[r]));_.set(o,"hasDataAttrs",!0)}return i}return"object"==typeof n?this.each(function(){z.set(this,n)}):M(this,function(e){var t;if(o&&void 0===e)return void 0!==(t=z.get(o,n))?t:void 0!==(t=V(o,n))?t:void 0;this.each(function(){z.set(this,n,e)})},null,e,1<arguments.length,null,!0)},removeData:function(e){return this.each(function(){z.remove(this,e)})}}),ce.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=_.get(e,t),n&&(!r||Array.isArray(n)?r=_.access(e,t,ce.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=ce.queue(e,t),r=n.length,i=n.shift(),o=ce._queueHooks(e,t);"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,function(){ce.dequeue(e,t)},o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return _.get(e,n)||_.access(e,n,{empty:ce.Callbacks("once memory").add(function(){_.remove(e,[t+"queue",n])})})}}),ce.fn.extend({queue:function(t,n){var e=2;return"string"!=typeof t&&(n=t,t="fx",e--),arguments.length<e?ce.queue(this[0],t):void 0===n?this:this.each(function(){var e=ce.queue(this,t,n);ce._queueHooks(this,t),"fx"===t&&"inprogress"!==e[0]&&ce.dequeue(this,t)})},dequeue:function(e){return this.each(function(){ce.dequeue(this,e)})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,t){var n,r=1,i=ce.Deferred(),o=this,a=this.length,s=function(){--r||i.resolveWith(o,[o])};"string"!=typeof e&&(t=e,e=void 0),e=e||"fx";while(a--)(n=_.get(o[a],e+"queueHooks"))&&n.empty&&(r++,n.empty.add(s));return s(),i.promise(t)}});var G=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,Y=new RegExp("^(?:([+-])=|)("+G+")([a-z%]*)$","i"),Q=["Top","Right","Bottom","Left"],J=C.documentElement,K=function(e){return ce.contains(e.ownerDocument,e)},Z={composed:!0};J.getRootNode&&(K=function(e){return ce.contains(e.ownerDocument,e)||e.getRootNode(Z)===e.ownerDocument});var ee=function(e,t){return"none"===(e=t||e).style.display||""===e.style.display&&K(e)&&"none"===ce.css(e,"display")};function te(e,t,n,r){var i,o,a=20,s=r?function(){return r.cur()}:function(){return ce.css(e,t,"")},u=s(),l=n&&n[3]||(ce.cssNumber[t]?"":"px"),c=e.nodeType&&(ce.cssNumber[t]||"px"!==l&&+u)&&Y.exec(ce.css(e,t));if(c&&c[3]!==l){u/=2,l=l||c[3],c=+u||1;while(a--)ce.style(e,t,c+l),(1-o)*(1-(o=s()/u||.5))<=0&&(a=0),c/=o;c*=2,ce.style(e,t,c+l),n=n||[]}return n&&(c=+c||+u||0,i=n[1]?c+(n[1]+1)*n[2]:+n[2],r&&(r.unit=l,r.start=c,r.end=i)),i}var ne={};function re(e,t){for(var n,r,i,o,a,s,u,l=[],c=0,f=e.length;c<f;c++)(r=e[c]).style&&(n=r.style.display,t?("none"===n&&(l[c]=_.get(r,"display")||null,l[c]||(r.style.display="")),""===r.style.display&&ee(r)&&(l[c]=(u=a=o=void 0,a=(i=r).ownerDocument,s=i.nodeName,(u=ne[s])||(o=a.body.appendChild(a.createElement(s)),u=ce.css(o,"display"),o.parentNode.removeChild(o),"none"===u&&(u="block"),ne[s]=u)))):"none"!==n&&(l[c]="none",_.set(r,"display",n)));for(c=0;c<f;c++)null!=l[c]&&(e[c].style.display=l[c]);return e}ce.fn.extend({show:function(){return re(this,!0)},hide:function(){return re(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){ee(this)?ce(this).show():ce(this).hide()})}});var xe,be,we=/^(?:checkbox|radio)$/i,Te=/<([a-z][^\/\0>\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="<textarea>x</textarea>",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="<option></option>",le.option=!!xe.lastChild;var ke={thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n<r;n++)_.set(e[n],"globalEval",!t||_.get(t[n],"globalEval"))}ke.tbody=ke.tfoot=ke.colgroup=ke.caption=ke.thead,ke.th=ke.td,le.option||(ke.optgroup=ke.option=[1,"<select multiple='multiple'>","</select>"]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d<h;d++)if((o=e[d])||0===o)if("object"===x(o))ce.merge(p,o.nodeType?[o]:o);else if(je.test(o)){a=a||f.appendChild(t.createElement("div")),s=(Te.exec(o)||["",""])[1].toLowerCase(),u=ke[s]||ke._default,a.innerHTML=u[1]+ce.htmlPrefilter(o)+u[2],c=u[0];while(c--)a=a.lastChild;ce.merge(p,a.childNodes),(a=f.firstChild).textContent=""}else p.push(t.createTextNode(o));f.textContent="",d=0;while(o=p[d++])if(r&&-1<ce.inArray(o,r))i&&i.push(o);else if(l=K(o),a=Se(f.appendChild(o),"script"),l&&Ee(a),n){c=0;while(o=a[c++])Ce.test(o.type||"")&&n.push(o)}return f}var De=/^([^.]*)(?:\.(.+)|)/;function Ne(){return!0}function qe(){return!1}function Le(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Le(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=qe;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return ce().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=ce.guid++)),e.each(function(){ce.event.add(this,t,i,r,n)})}function He(e,r,t){t?(_.set(e,r,!1),ce.event.add(e,r,{namespace:!1,handler:function(e){var t,n=_.get(this,r);if(1&e.isTrigger&&this[r]){if(n)(ce.event.special[r]||{}).delegateType&&e.stopPropagation();else if(n=ae.call(arguments),_.set(this,r,n),this[r](),t=_.get(this,r),_.set(this,r,!1),n!==t)return e.stopImmediatePropagation(),e.preventDefault(),t}else n&&(_.set(this,r,ce.event.trigger(n[0],n.slice(1),this)),e.stopPropagation(),e.isImmediatePropagationStopped=Ne)}})):void 0===_.get(e,r)&&ce.event.add(e,r,Ne)}ce.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=_.get(t);if($(t)){n.handler&&(n=(o=n).handler,i=o.selector),i&&ce.find.matchesSelector(J,i),n.guid||(n.guid=ce.guid++),(u=v.events)||(u=v.events=Object.create(null)),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof ce&&ce.event.triggered!==e.type?ce.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(D)||[""]).length;while(l--)d=g=(s=De.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=ce.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=ce.event.special[d]||{},c=ce.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&ce.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),ce.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=_.hasData(e)&&_.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(D)||[""]).length;while(l--)if(d=g=(s=De.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=ce.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||ce.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)ce.event.remove(e,d+t[l],n,r,!0);ce.isEmptyObject(u)&&_.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=new Array(arguments.length),u=ce.event.fix(e),l=(_.get(this,"events")||Object.create(null))[u.type]||[],c=ce.event.special[u.type]||{};for(s[0]=u,t=1;t<arguments.length;t++)s[t]=arguments[t];if(u.delegateTarget=this,!c.preDispatch||!1!==c.preDispatch.call(this,u)){a=ce.event.handlers.call(this,u,l),t=0;while((i=a[t++])&&!u.isPropagationStopped()){u.currentTarget=i.elem,n=0;while((o=i.handlers[n++])&&!u.isImmediatePropagationStopped())u.rnamespace&&!1!==o.namespace&&!u.rnamespace.test(o.namespace)||(u.handleObj=o,u.data=o.data,void 0!==(r=((ce.event.special[o.origType]||{}).handle||o.handler).apply(i.elem,s))&&!1===(u.result=r)&&(u.preventDefault(),u.stopPropagation()))}return c.postDispatch&&c.postDispatch.call(this,u),u.result}},handlers:function(e,t){var n,r,i,o,a,s=[],u=t.delegateCount,l=e.target;if(u&&l.nodeType&&!("click"===e.type&&1<=e.button))for(;l!==this;l=l.parentNode||this)if(1===l.nodeType&&("click"!==e.type||!0!==l.disabled)){for(o=[],a={},n=0;n<u;n++)void 0===a[i=(r=t[n]).selector+" "]&&(a[i]=r.needsContext?-1<ce(i,this).index(l):ce.find(i,this,null,[l]).length),a[i]&&o.push(r);o.length&&s.push({elem:l,handlers:o})}return l=this,u<t.length&&s.push({elem:l,handlers:t.slice(u)}),s},addProp:function(t,e){Object.defineProperty(ce.Event.prototype,t,{enumerable:!0,configurable:!0,get:v(e)?function(){if(this.originalEvent)return e(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[t]},set:function(e){Object.defineProperty(this,t,{enumerable:!0,configurable:!0,writable:!0,value:e})}})},fix:function(e){return e[ce.expando]?e:new ce.Event(e)},special:{load:{noBubble:!0},click:{setup:function(e){var t=this||e;return we.test(t.type)&&t.click&&fe(t,"input")&&He(t,"click",!0),!1},trigger:function(e){var t=this||e;return we.test(t.type)&&t.click&&fe(t,"input")&&He(t,"click"),!0},_default:function(e){var t=e.target;return we.test(t.type)&&t.click&&fe(t,"input")&&_.get(t,"click")||fe(t,"a")}},beforeunload:{postDispatch:function(e){void 0!==e.result&&e.originalEvent&&(e.originalEvent.returnValue=e.result)}}}},ce.removeEvent=function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n)},ce.Event=function(e,t){if(!(this instanceof ce.Event))return new ce.Event(e,t);e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||void 0===e.defaultPrevented&&!1===e.returnValue?Ne:qe,this.target=e.target&&3===e.target.nodeType?e.target.parentNode:e.target,this.currentTarget=e.currentTarget,this.relatedTarget=e.relatedTarget):this.type=e,t&&ce.extend(this,t),this.timeStamp=e&&e.timeStamp||Date.now(),this[ce.expando]=!0},ce.Event.prototype={constructor:ce.Event,isDefaultPrevented:qe,isPropagationStopped:qe,isImmediatePropagationStopped:qe,isSimulated:!1,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=Ne,e&&!this.isSimulated&&e.preventDefault()},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=Ne,e&&!this.isSimulated&&e.stopPropagation()},stopImmediatePropagation:function(){var e=this.originalEvent;this.isImmediatePropagationStopped=Ne,e&&!this.isSimulated&&e.stopImmediatePropagation(),this.stopPropagation()}},ce.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,code:!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:!0},ce.event.addProp),ce.each({focus:"focusin",blur:"focusout"},function(r,i){function o(e){if(C.documentMode){var t=_.get(this,"handle"),n=ce.event.fix(e);n.type="focusin"===e.type?"focus":"blur",n.isSimulated=!0,t(e),n.target===n.currentTarget&&t(n)}else ce.event.simulate(i,e.target,ce.event.fix(e))}ce.event.special[r]={setup:function(){var e;if(He(this,r,!0),!C.documentMode)return!1;(e=_.get(this,i))||this.addEventListener(i,o),_.set(this,i,(e||0)+1)},trigger:function(){return He(this,r),!0},teardown:function(){var e;if(!C.documentMode)return!1;(e=_.get(this,i)-1)?_.set(this,i,e):(this.removeEventListener(i,o),_.remove(this,i))},_default:function(e){return _.get(e.target,r)},delegateType:i},ce.event.special[i]={setup:function(){var e=this.ownerDocument||this.document||this,t=C.documentMode?this:e,n=_.get(t,i);n||(C.documentMode?this.addEventListener(i,o):e.addEventListener(r,o,!0)),_.set(t,i,(n||0)+1)},teardown:function(){var e=this.ownerDocument||this.document||this,t=C.documentMode?this:e,n=_.get(t,i)-1;n?_.set(t,i,n):(C.documentMode?this.removeEventListener(i,o):e.removeEventListener(r,o,!0),_.remove(t,i))}}}),ce.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(e,i){ce.event.special[e]={delegateType:i,bindType:i,handle:function(e){var t,n=e.relatedTarget,r=e.handleObj;return n&&(n===this||ce.contains(this,n))||(e.type=r.origType,t=r.handler.apply(this,arguments),e.type=i),t}}}),ce.fn.extend({on:function(e,t,n,r){return Le(this,e,t,n,r)},one:function(e,t,n,r){return Le(this,e,t,n,r,1)},off:function(e,t,n){var r,i;if(e&&e.preventDefault&&e.handleObj)return r=e.handleObj,ce(e.delegateTarget).off(r.namespace?r.origType+"."+r.namespace:r.origType,r.selector,r.handler),this;if("object"==typeof e){for(i in e)this.off(i,t,e[i]);return this}return!1!==t&&"function"!=typeof t||(n=t,t=void 0),!1===n&&(n=qe),this.each(function(){ce.event.remove(this,e,n,t)})}});var Oe=/<script|<style|<link/i,Pe=/checked\s*(?:[^=]|=\s*.checked.)/i,Me=/^\s*<!\[CDATA\[|\]\]>\s*$/g;function Re(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n<r;n++)ce.event.add(t,i,s[i][n]);z.hasData(e)&&(o=z.access(e),a=ce.extend({},o),z.set(t,a))}}function $e(n,r,i,o){r=g(r);var e,t,a,s,u,l,c=0,f=n.length,p=f-1,d=r[0],h=v(d);if(h||1<f&&"string"==typeof d&&!le.checkClone&&Pe.test(d))return n.each(function(e){var t=n.eq(e);h&&(r[0]=d.call(this,e,t.html())),$e(t,r,i,o)});if(f&&(t=(e=Ae(r,n[0].ownerDocument,!1,n,o)).firstChild,1===e.childNodes.length&&(e=t),t||o)){for(s=(a=ce.map(Se(e,"script"),Ie)).length;c<f;c++)u=e,c!==p&&(u=ce.clone(u,!0,!0),s&&ce.merge(a,Se(u,"script"))),i.call(n[c],u,c);if(s)for(l=a[a.length-1].ownerDocument,ce.map(a,We),c=0;c<s;c++)u=a[c],Ce.test(u.type||"")&&!_.access(u,"globalEval")&&ce.contains(l,u)&&(u.src&&"module"!==(u.type||"").toLowerCase()?ce._evalUrl&&!u.noModule&&ce._evalUrl(u.src,{nonce:u.nonce||u.getAttribute("nonce")},l):m(u.textContent.replace(Me,""),u,l))}return n}function Be(e,t,n){for(var r,i=t?ce.filter(t,e):e,o=0;null!=(r=i[o]);o++)n||1!==r.nodeType||ce.cleanData(Se(r)),r.parentNode&&(n&&K(r)&&Ee(Se(r,"script")),r.parentNode.removeChild(r));return e}ce.extend({htmlPrefilter:function(e){return e},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=K(e);if(!(le.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||ce.isXMLDoc(e)))for(a=Se(c),r=0,i=(o=Se(e)).length;r<i;r++)s=o[r],u=a[r],void 0,"input"===(l=u.nodeName.toLowerCase())&&we.test(s.type)?u.checked=s.checked:"input"!==l&&"textarea"!==l||(u.defaultValue=s.defaultValue);if(t)if(n)for(o=o||Se(e),a=a||Se(c),r=0,i=o.length;r<i;r++)Fe(o[r],a[r]);else Fe(e,c);return 0<(a=Se(c,"script")).length&&Ee(a,!f&&Se(e,"script")),c},cleanData:function(e){for(var t,n,r,i=ce.event.special,o=0;void 0!==(n=e[o]);o++)if($(n)){if(t=n[_.expando]){if(t.events)for(r in t.events)i[r]?ce.event.remove(n,r):ce.removeEvent(n,r,t.handle);n[_.expando]=void 0}n[z.expando]&&(n[z.expando]=void 0)}}}),ce.fn.extend({detach:function(e){return Be(this,e,!0)},remove:function(e){return Be(this,e)},text:function(e){return M(this,function(e){return void 0===e?ce.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=e)})},null,e,arguments.length)},append:function(){return $e(this,arguments,function(e){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||Re(this,e).appendChild(e)})},prepend:function(){return $e(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=Re(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return $e(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return $e(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},empty:function(){for(var e,t=0;null!=(e=this[t]);t++)1===e.nodeType&&(ce.cleanData(Se(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null!=e&&e,t=null==t?e:t,this.map(function(){return ce.clone(this,e,t)})},html:function(e){return M(this,function(e){var t=this[0]||{},n=0,r=this.length;if(void 0===e&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!Oe.test(e)&&!ke[(Te.exec(e)||["",""])[1].toLowerCase()]){e=ce.htmlPrefilter(e);try{for(;n<r;n++)1===(t=this[n]||{}).nodeType&&(ce.cleanData(Se(t,!1)),t.innerHTML=e);t=0}catch(e){}}t&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var n=[];return $e(this,arguments,function(e){var t=this.parentNode;ce.inArray(this,n)<0&&(ce.cleanData(Se(this)),t&&t.replaceChild(e,this))},n)}}),ce.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,a){ce.fn[e]=function(e){for(var t,n=[],r=ce(e),i=r.length-1,o=0;o<=i;o++)t=o===i?this:this.clone(!0),ce(r[o])[a](t),s.apply(n,t.get());return this.pushStack(n)}});var _e=new RegExp("^("+G+")(?!px)[a-z%]+$","i"),ze=/^--/,Xe=function(e){var t=e.ownerDocument.defaultView;return t&&t.opener||(t=ie),t.getComputedStyle(e)},Ue=function(e,t,n){var r,i,o={};for(i in t)o[i]=e.style[i],e.style[i]=t[i];for(i in r=n.call(e),t)e.style[i]=o[i];return r},Ve=new RegExp(Q.join("|"),"i");function Ge(e,t,n){var r,i,o,a,s=ze.test(t),u=e.style;return(n=n||Xe(e))&&(a=n.getPropertyValue(t)||n[t],s&&a&&(a=a.replace(ve,"$1")||void 0),""!==a||K(e)||(a=ce.style(e,t)),!le.pixelBoxStyles()&&_e.test(a)&&Ve.test(t)&&(r=u.width,i=u.minWidth,o=u.maxWidth,u.minWidth=u.maxWidth=u.width=a,a=n.width,u.width=r,u.minWidth=i,u.maxWidth=o)),void 0!==a?a+"":a}function Ye(e,t){return{get:function(){if(!e())return(this.get=t).apply(this,arguments);delete this.get}}}!function(){function e(){if(l){u.style.cssText="position:absolute;left:-11111px;width:60px;margin-top:1px;padding:0;border:0",l.style.cssText="position:relative;display:block;box-sizing:border-box;overflow:scroll;margin:auto;border:1px;padding:1px;width:60%;top:1%",J.appendChild(u).appendChild(l);var e=ie.getComputedStyle(l);n="1%"!==e.top,s=12===t(e.marginLeft),l.style.right="60%",o=36===t(e.right),r=36===t(e.width),l.style.position="absolute",i=12===t(l.offsetWidth/3),J.removeChild(u),l=null}}function t(e){return Math.round(parseFloat(e))}var n,r,i,o,a,s,u=C.createElement("div"),l=C.createElement("div");l.style&&(l.style.backgroundClip="content-box",l.cloneNode(!0).style.backgroundClip="",le.clearCloneStyle="content-box"===l.style.backgroundClip,ce.extend(le,{boxSizingReliable:function(){return e(),r},pixelBoxStyles:function(){return e(),o},pixelPosition:function(){return e(),n},reliableMarginLeft:function(){return e(),s},scrollboxSize:function(){return e(),i},reliableTrDimensions:function(){var e,t,n,r;return null==a&&(e=C.createElement("table"),t=C.createElement("tr"),n=C.createElement("div"),e.style.cssText="position:absolute;left:-11111px;border-collapse:separate",t.style.cssText="box-sizing:content-box;border:1px solid",t.style.height="1px",n.style.height="9px",n.style.display="block",J.appendChild(e).appendChild(t).appendChild(n),r=ie.getComputedStyle(t),a=parseInt(r.height,10)+parseInt(r.borderTopWidth,10)+parseInt(r.borderBottomWidth,10)===t.offsetHeight,J.removeChild(e)),a}}))}();var Qe=["Webkit","Moz","ms"],Je=C.createElement("div").style,Ke={};function Ze(e){var t=ce.cssProps[e]||Ke[e];return t||(e in Je?e:Ke[e]=function(e){var t=e[0].toUpperCase()+e.slice(1),n=Qe.length;while(n--)if((e=Qe[n]+t)in Je)return e}(e)||e)}var et=/^(none|table(?!-c[ea]).+)/,tt={position:"absolute",visibility:"hidden",display:"block"},nt={letterSpacing:"0",fontWeight:"400"};function rt(e,t,n){var r=Y.exec(t);return r?Math.max(0,r[2]-(n||0))+(r[3]||"px"):t}function it(e,t,n,r,i,o){var a="width"===t?1:0,s=0,u=0,l=0;if(n===(r?"border":"content"))return 0;for(;a<4;a+=2)"margin"===n&&(l+=ce.css(e,n+Q[a],!0,i)),r?("content"===n&&(u-=ce.css(e,"padding"+Q[a],!0,i)),"margin"!==n&&(u-=ce.css(e,"border"+Q[a]+"Width",!0,i))):(u+=ce.css(e,"padding"+Q[a],!0,i),"padding"!==n?u+=ce.css(e,"border"+Q[a]+"Width",!0,i):s+=ce.css(e,"border"+Q[a]+"Width",!0,i));return!r&&0<=o&&(u+=Math.max(0,Math.ceil(e["offset"+t[0].toUpperCase()+t.slice(1)]-o-u-s-.5))||0),u+l}function ot(e,t,n){var r=Xe(e),i=(!le.boxSizingReliable()||n)&&"border-box"===ce.css(e,"boxSizing",!1,r),o=i,a=Ge(e,t,r),s="offset"+t[0].toUpperCase()+t.slice(1);if(_e.test(a)){if(!n)return a;a="auto"}return(!le.boxSizingReliable()&&i||!le.reliableTrDimensions()&&fe(e,"tr")||"auto"===a||!parseFloat(a)&&"inline"===ce.css(e,"display",!1,r))&&e.getClientRects().length&&(i="border-box"===ce.css(e,"boxSizing",!1,r),(o=s in e)&&(a=e[s])),(a=parseFloat(a)||0)+it(e,t,n||(i?"border":"content"),o,r,a)+"px"}function at(e,t,n,r,i){return new at.prototype.init(e,t,n,r,i)}ce.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Ge(e,"opacity");return""===n?"1":n}}}},cssNumber:{animationIterationCount:!0,aspectRatio:!0,borderImageSlice:!0,columnCount:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,gridArea:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnStart:!0,gridRow:!0,gridRowEnd:!0,gridRowStart:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,scale:!0,widows:!0,zIndex:!0,zoom:!0,fillOpacity:!0,floodOpacity:!0,stopOpacity:!0,strokeMiterlimit:!0,strokeOpacity:!0},cssProps:{},style:function(e,t,n,r){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var i,o,a,s=F(t),u=ze.test(t),l=e.style;if(u||(t=Ze(s)),a=ce.cssHooks[t]||ce.cssHooks[s],void 0===n)return a&&"get"in a&&void 0!==(i=a.get(e,!1,r))?i:l[t];"string"===(o=typeof n)&&(i=Y.exec(n))&&i[1]&&(n=te(e,t,i),o="number"),null!=n&&n==n&&("number"!==o||u||(n+=i&&i[3]||(ce.cssNumber[s]?"":"px")),le.clearCloneStyle||""!==n||0!==t.indexOf("background")||(l[t]="inherit"),a&&"set"in a&&void 0===(n=a.set(e,n,r))||(u?l.setProperty(t,n):l[t]=n))}},css:function(e,t,n,r){var i,o,a,s=F(t);return ze.test(t)||(t=Ze(s)),(a=ce.cssHooks[t]||ce.cssHooks[s])&&"get"in a&&(i=a.get(e,!0,n)),void 0===i&&(i=Ge(e,t,r)),"normal"===i&&t in nt&&(i=nt[t]),""===n||n?(o=parseFloat(i),!0===n||isFinite(o)?o||0:i):i}}),ce.each(["height","width"],function(e,u){ce.cssHooks[u]={get:function(e,t,n){if(t)return!et.test(ce.css(e,"display"))||e.getClientRects().length&&e.getBoundingClientRect().width?ot(e,u,n):Ue(e,tt,function(){return ot(e,u,n)})},set:function(e,t,n){var r,i=Xe(e),o=!le.scrollboxSize()&&"absolute"===i.position,a=(o||n)&&"border-box"===ce.css(e,"boxSizing",!1,i),s=n?it(e,u,n,a,i):0;return a&&o&&(s-=Math.ceil(e["offset"+u[0].toUpperCase()+u.slice(1)]-parseFloat(i[u])-it(e,u,"border",!1,i)-.5)),s&&(r=Y.exec(t))&&"px"!==(r[3]||"px")&&(e.style[u]=t,t=ce.css(e,u)),rt(0,t,s)}}}),ce.cssHooks.marginLeft=Ye(le.reliableMarginLeft,function(e,t){if(t)return(parseFloat(Ge(e,"marginLeft"))||e.getBoundingClientRect().left-Ue(e,{marginLeft:0},function(){return e.getBoundingClientRect().left}))+"px"}),ce.each({margin:"",padding:"",border:"Width"},function(i,o){ce.cssHooks[i+o]={expand:function(e){for(var t=0,n={},r="string"==typeof e?e.split(" "):[e];t<4;t++)n[i+Q[t]+o]=r[t]||r[t-2]||r[0];return n}},"margin"!==i&&(ce.cssHooks[i+o].set=rt)}),ce.fn.extend({css:function(e,t){return M(this,function(e,t,n){var r,i,o={},a=0;if(Array.isArray(t)){for(r=Xe(e),i=t.length;a<i;a++)o[t[a]]=ce.css(e,t[a],!1,r);return o}return void 0!==n?ce.style(e,t,n):ce.css(e,t)},e,t,1<arguments.length)}}),((ce.Tween=at).prototype={constructor:at,init:function(e,t,n,r,i,o){this.elem=e,this.prop=n,this.easing=i||ce.easing._default,this.options=t,this.start=this.now=this.cur(),this.end=r,this.unit=o||(ce.cssNumber[n]?"":"px")},cur:function(){var e=at.propHooks[this.prop];return e&&e.get?e.get(this):at.propHooks._default.get(this)},run:function(e){var t,n=at.propHooks[this.prop];return this.options.duration?this.pos=t=ce.easing[this.easing](e,this.options.duration*e,0,1,this.options.duration):this.pos=t=e,this.now=(this.end-this.start)*t+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),n&&n.set?n.set(this):at.propHooks._default.set(this),this}}).init.prototype=at.prototype,(at.propHooks={_default:{get:function(e){var t;return 1!==e.elem.nodeType||null!=e.elem[e.prop]&&null==e.elem.style[e.prop]?e.elem[e.prop]:(t=ce.css(e.elem,e.prop,""))&&"auto"!==t?t:0},set:function(e){ce.fx.step[e.prop]?ce.fx.step[e.prop](e):1!==e.elem.nodeType||!ce.cssHooks[e.prop]&&null==e.elem.style[Ze(e.prop)]?e.elem[e.prop]=e.now:ce.style(e.elem,e.prop,e.now+e.unit)}}}).scrollTop=at.propHooks.scrollLeft={set:function(e){e.elem.nodeType&&e.elem.parentNode&&(e.elem[e.prop]=e.now)}},ce.easing={linear:function(e){return e},swing:function(e){return.5-Math.cos(e*Math.PI)/2},_default:"swing"},ce.fx=at.prototype.init,ce.fx.step={};var st,ut,lt,ct,ft=/^(?:toggle|show|hide)$/,pt=/queueHooks$/;function dt(){ut&&(!1===C.hidden&&ie.requestAnimationFrame?ie.requestAnimationFrame(dt):ie.setTimeout(dt,ce.fx.interval),ce.fx.tick())}function ht(){return ie.setTimeout(function(){st=void 0}),st=Date.now()}function gt(e,t){var n,r=0,i={height:e};for(t=t?1:0;r<4;r+=2-t)i["margin"+(n=Q[r])]=i["padding"+n]=e;return t&&(i.opacity=i.width=e),i}function vt(e,t,n){for(var r,i=(yt.tweeners[t]||[]).concat(yt.tweeners["*"]),o=0,a=i.length;o<a;o++)if(r=i[o].call(n,t,e))return r}function yt(o,e,t){var n,a,r=0,i=yt.prefilters.length,s=ce.Deferred().always(function(){delete u.elem}),u=function(){if(a)return!1;for(var e=st||ht(),t=Math.max(0,l.startTime+l.duration-e),n=1-(t/l.duration||0),r=0,i=l.tweens.length;r<i;r++)l.tweens[r].run(n);return s.notifyWith(o,[l,n,t]),n<1&&i?t:(i||s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l]),!1)},l=s.promise({elem:o,props:ce.extend({},e),opts:ce.extend(!0,{specialEasing:{},easing:ce.easing._default},t),originalProperties:e,originalOptions:t,startTime:st||ht(),duration:t.duration,tweens:[],createTween:function(e,t){var n=ce.Tween(o,l.opts,e,t,l.opts.specialEasing[e]||l.opts.easing);return l.tweens.push(n),n},stop:function(e){var t=0,n=e?l.tweens.length:0;if(a)return this;for(a=!0;t<n;t++)l.tweens[t].run(1);return e?(s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l,e])):s.rejectWith(o,[l,e]),this}}),c=l.props;for(!function(e,t){var n,r,i,o,a;for(n in e)if(i=t[r=F(n)],o=e[n],Array.isArray(o)&&(i=o[1],o=e[n]=o[0]),n!==r&&(e[r]=o,delete e[n]),(a=ce.cssHooks[r])&&"expand"in a)for(n in o=a.expand(o),delete e[r],o)n in e||(e[n]=o[n],t[n]=i);else t[r]=i}(c,l.opts.specialEasing);r<i;r++)if(n=yt.prefilters[r].call(l,o,c,l.opts))return v(n.stop)&&(ce._queueHooks(l.elem,l.opts.queue).stop=n.stop.bind(n)),n;return ce.map(c,vt,l),v(l.opts.start)&&l.opts.start.call(o,l),l.progress(l.opts.progress).done(l.opts.done,l.opts.complete).fail(l.opts.fail).always(l.opts.always),ce.fx.timer(ce.extend(u,{elem:o,anim:l,queue:l.opts.queue})),l}ce.Animation=ce.extend(yt,{tweeners:{"*":[function(e,t){var n=this.createTween(e,t);return te(n.elem,e,Y.exec(t),n),n}]},tweener:function(e,t){v(e)?(t=e,e=["*"]):e=e.match(D);for(var n,r=0,i=e.length;r<i;r++)n=e[r],yt.tweeners[n]=yt.tweeners[n]||[],yt.tweeners[n].unshift(t)},prefilters:[function(e,t,n){var r,i,o,a,s,u,l,c,f="width"in t||"height"in t,p=this,d={},h=e.style,g=e.nodeType&&ee(e),v=_.get(e,"fxshow");for(r in n.queue||(null==(a=ce._queueHooks(e,"fx")).unqueued&&(a.unqueued=0,s=a.empty.fire,a.empty.fire=function(){a.unqueued||s()}),a.unqueued++,p.always(function(){p.always(function(){a.unqueued--,ce.queue(e,"fx").length||a.empty.fire()})})),t)if(i=t[r],ft.test(i)){if(delete t[r],o=o||"toggle"===i,i===(g?"hide":"show")){if("show"!==i||!v||void 0===v[r])continue;g=!0}d[r]=v&&v[r]||ce.style(e,r)}if((u=!ce.isEmptyObject(t))||!ce.isEmptyObject(d))for(r in f&&1===e.nodeType&&(n.overflow=[h.overflow,h.overflowX,h.overflowY],null==(l=v&&v.display)&&(l=_.get(e,"display")),"none"===(c=ce.css(e,"display"))&&(l?c=l:(re([e],!0),l=e.style.display||l,c=ce.css(e,"display"),re([e]))),("inline"===c||"inline-block"===c&&null!=l)&&"none"===ce.css(e,"float")&&(u||(p.done(function(){h.display=l}),null==l&&(c=h.display,l="none"===c?"":c)),h.display="inline-block")),n.overflow&&(h.overflow="hidden",p.always(function(){h.overflow=n.overflow[0],h.overflowX=n.overflow[1],h.overflowY=n.overflow[2]})),u=!1,d)u||(v?"hidden"in v&&(g=v.hidden):v=_.access(e,"fxshow",{display:l}),o&&(v.hidden=!g),g&&re([e],!0),p.done(function(){for(r in g||re([e]),_.remove(e,"fxshow"),d)ce.style(e,r,d[r])})),u=vt(g?v[r]:0,r,p),r in v||(v[r]=u.start,g&&(u.end=u.start,u.start=0))}],prefilter:function(e,t){t?yt.prefilters.unshift(e):yt.prefilters.push(e)}}),ce.speed=function(e,t,n){var r=e&&"object"==typeof e?ce.extend({},e):{complete:n||!n&&t||v(e)&&e,duration:e,easing:n&&t||t&&!v(t)&&t};return ce.fx.off?r.duration=0:"number"!=typeof r.duration&&(r.duration in ce.fx.speeds?r.duration=ce.fx.speeds[r.duration]:r.duration=ce.fx.speeds._default),null!=r.queue&&!0!==r.queue||(r.queue="fx"),r.old=r.complete,r.complete=function(){v(r.old)&&r.old.call(this),r.queue&&ce.dequeue(this,r.queue)},r},ce.fn.extend({fadeTo:function(e,t,n,r){return this.filter(ee).css("opacity",0).show().end().animate({opacity:t},e,n,r)},animate:function(t,e,n,r){var i=ce.isEmptyObject(t),o=ce.speed(e,n,r),a=function(){var e=yt(this,ce.extend({},t),o);(i||_.get(this,"finish"))&&e.stop(!0)};return a.finish=a,i||!1===o.queue?this.each(a):this.queue(o.queue,a)},stop:function(i,e,o){var a=function(e){var t=e.stop;delete e.stop,t(o)};return"string"!=typeof i&&(o=e,e=i,i=void 0),e&&this.queue(i||"fx",[]),this.each(function(){var e=!0,t=null!=i&&i+"queueHooks",n=ce.timers,r=_.get(this);if(t)r[t]&&r[t].stop&&a(r[t]);else for(t in r)r[t]&&r[t].stop&&pt.test(t)&&a(r[t]);for(t=n.length;t--;)n[t].elem!==this||null!=i&&n[t].queue!==i||(n[t].anim.stop(o),e=!1,n.splice(t,1));!e&&o||ce.dequeue(this,i)})},finish:function(a){return!1!==a&&(a=a||"fx"),this.each(function(){var e,t=_.get(this),n=t[a+"queue"],r=t[a+"queueHooks"],i=ce.timers,o=n?n.length:0;for(t.finish=!0,ce.queue(this,a,[]),r&&r.stop&&r.stop.call(this,!0),e=i.length;e--;)i[e].elem===this&&i[e].queue===a&&(i[e].anim.stop(!0),i.splice(e,1));for(e=0;e<o;e++)n[e]&&n[e].finish&&n[e].finish.call(this);delete t.finish})}}),ce.each(["toggle","show","hide"],function(e,r){var i=ce.fn[r];ce.fn[r]=function(e,t,n){return null==e||"boolean"==typeof e?i.apply(this,arguments):this.animate(gt(r,!0),e,t,n)}}),ce.each({slideDown:gt("show"),slideUp:gt("hide"),slideToggle:gt("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(e,r){ce.fn[e]=function(e,t,n){return this.animate(r,e,t,n)}}),ce.timers=[],ce.fx.tick=function(){var e,t=0,n=ce.timers;for(st=Date.now();t<n.length;t++)(e=n[t])()||n[t]!==e||n.splice(t--,1);n.length||ce.fx.stop(),st=void 0},ce.fx.timer=function(e){ce.timers.push(e),ce.fx.start()},ce.fx.interval=13,ce.fx.start=function(){ut||(ut=!0,dt())},ce.fx.stop=function(){ut=null},ce.fx.speeds={slow:600,fast:200,_default:400},ce.fn.delay=function(r,e){return r=ce.fx&&ce.fx.speeds[r]||r,e=e||"fx",this.queue(e,function(e,t){var n=ie.setTimeout(e,r);t.stop=function(){ie.clearTimeout(n)}})},lt=C.createElement("input"),ct=C.createElement("select").appendChild(C.createElement("option")),lt.type="checkbox",le.checkOn=""!==lt.value,le.optSelected=ct.selected,(lt=C.createElement("input")).value="t",lt.type="radio",le.radioValue="t"===lt.value;var mt,xt=ce.expr.attrHandle;ce.fn.extend({attr:function(e,t){return M(this,ce.attr,e,t,1<arguments.length)},removeAttr:function(e){return this.each(function(){ce.removeAttr(this,e)})}}),ce.extend({attr:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return"undefined"==typeof e.getAttribute?ce.prop(e,t,n):(1===o&&ce.isXMLDoc(e)||(i=ce.attrHooks[t.toLowerCase()]||(ce.expr.match.bool.test(t)?mt:void 0)),void 0!==n?null===n?void ce.removeAttr(e,t):i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:(e.setAttribute(t,n+""),n):i&&"get"in i&&null!==(r=i.get(e,t))?r:null==(r=ce.find.attr(e,t))?void 0:r)},attrHooks:{type:{set:function(e,t){if(!le.radioValue&&"radio"===t&&fe(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},removeAttr:function(e,t){var n,r=0,i=t&&t.match(D);if(i&&1===e.nodeType)while(n=i[r++])e.removeAttribute(n)}}),mt={set:function(e,t,n){return!1===t?ce.removeAttr(e,n):e.setAttribute(n,n),n}},ce.each(ce.expr.match.bool.source.match(/\w+/g),function(e,t){var a=xt[t]||ce.find.attr;xt[t]=function(e,t,n){var r,i,o=t.toLowerCase();return n||(i=xt[o],xt[o]=r,r=null!=a(e,t,n)?o:null,xt[o]=i),r}});var bt=/^(?:input|select|textarea|button)$/i,wt=/^(?:a|area)$/i;function Tt(e){return(e.match(D)||[]).join(" ")}function Ct(e){return e.getAttribute&&e.getAttribute("class")||""}function kt(e){return Array.isArray(e)?e:"string"==typeof e&&e.match(D)||[]}ce.fn.extend({prop:function(e,t){return M(this,ce.prop,e,t,1<arguments.length)},removeProp:function(e){return this.each(function(){delete this[ce.propFix[e]||e]})}}),ce.extend({prop:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return 1===o&&ce.isXMLDoc(e)||(t=ce.propFix[t]||t,i=ce.propHooks[t]),void 0!==n?i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:e[t]=n:i&&"get"in i&&null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){var t=ce.find.attr(e,"tabindex");return t?parseInt(t,10):bt.test(e.nodeName)||wt.test(e.nodeName)&&e.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),le.optSelected||(ce.propHooks.selected={get:function(e){var t=e.parentNode;return t&&t.parentNode&&t.parentNode.selectedIndex,null},set:function(e){var t=e.parentNode;t&&(t.selectedIndex,t.parentNode&&t.parentNode.selectedIndex)}}),ce.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){ce.propFix[this.toLowerCase()]=this}),ce.fn.extend({addClass:function(t){var e,n,r,i,o,a;return v(t)?this.each(function(e){ce(this).addClass(t.call(this,e,Ct(this)))}):(e=kt(t)).length?this.each(function(){if(r=Ct(this),n=1===this.nodeType&&" "+Tt(r)+" "){for(o=0;o<e.length;o++)i=e[o],n.indexOf(" "+i+" ")<0&&(n+=i+" ");a=Tt(n),r!==a&&this.setAttribute("class",a)}}):this},removeClass:function(t){var e,n,r,i,o,a;return v(t)?this.each(function(e){ce(this).removeClass(t.call(this,e,Ct(this)))}):arguments.length?(e=kt(t)).length?this.each(function(){if(r=Ct(this),n=1===this.nodeType&&" "+Tt(r)+" "){for(o=0;o<e.length;o++){i=e[o];while(-1<n.indexOf(" "+i+" "))n=n.replace(" "+i+" "," ")}a=Tt(n),r!==a&&this.setAttribute("class",a)}}):this:this.attr("class","")},toggleClass:function(t,n){var e,r,i,o,a=typeof t,s="string"===a||Array.isArray(t);return v(t)?this.each(function(e){ce(this).toggleClass(t.call(this,e,Ct(this),n),n)}):"boolean"==typeof n&&s?n?this.addClass(t):this.removeClass(t):(e=kt(t),this.each(function(){if(s)for(o=ce(this),i=0;i<e.length;i++)r=e[i],o.hasClass(r)?o.removeClass(r):o.addClass(r);else void 0!==t&&"boolean"!==a||((r=Ct(this))&&_.set(this,"__className__",r),this.setAttribute&&this.setAttribute("class",r||!1===t?"":_.get(this,"__className__")||""))}))},hasClass:function(e){var t,n,r=0;t=" "+e+" ";while(n=this[r++])if(1===n.nodeType&&-1<(" "+Tt(Ct(n))+" ").indexOf(t))return!0;return!1}});var St=/\r/g;ce.fn.extend({val:function(n){var r,e,i,t=this[0];return arguments.length?(i=v(n),this.each(function(e){var t;1===this.nodeType&&(null==(t=i?n.call(this,e,ce(this).val()):n)?t="":"number"==typeof t?t+="":Array.isArray(t)&&(t=ce.map(t,function(e){return null==e?"":e+""})),(r=ce.valHooks[this.type]||ce.valHooks[this.nodeName.toLowerCase()])&&"set"in r&&void 0!==r.set(this,t,"value")||(this.value=t))})):t?(r=ce.valHooks[t.type]||ce.valHooks[t.nodeName.toLowerCase()])&&"get"in r&&void 0!==(e=r.get(t,"value"))?e:"string"==typeof(e=t.value)?e.replace(St,""):null==e?"":e:void 0}}),ce.extend({valHooks:{option:{get:function(e){var t=ce.find.attr(e,"value");return null!=t?t:Tt(ce.text(e))}},select:{get:function(e){var t,n,r,i=e.options,o=e.selectedIndex,a="select-one"===e.type,s=a?null:[],u=a?o+1:i.length;for(r=o<0?u:a?o:0;r<u;r++)if(((n=i[r]).selected||r===o)&&!n.disabled&&(!n.parentNode.disabled||!fe(n.parentNode,"optgroup"))){if(t=ce(n).val(),a)return t;s.push(t)}return s},set:function(e,t){var n,r,i=e.options,o=ce.makeArray(t),a=i.length;while(a--)((r=i[a]).selected=-1<ce.inArray(ce.valHooks.option.get(r),o))&&(n=!0);return n||(e.selectedIndex=-1),o}}}}),ce.each(["radio","checkbox"],function(){ce.valHooks[this]={set:function(e,t){if(Array.isArray(t))return e.checked=-1<ce.inArray(ce(e).val(),t)}},le.checkOn||(ce.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})});var Et=ie.location,jt={guid:Date.now()},At=/\?/;ce.parseXML=function(e){var t,n;if(!e||"string"!=typeof e)return null;try{t=(new ie.DOMParser).parseFromString(e,"text/xml")}catch(e){}return n=t&&t.getElementsByTagName("parsererror")[0],t&&!n||ce.error("Invalid XML: "+(n?ce.map(n.childNodes,function(e){return e.textContent}).join("\n"):e)),t};var Dt=/^(?:focusinfocus|focusoutblur)$/,Nt=function(e){e.stopPropagation()};ce.extend(ce.event,{trigger:function(e,t,n,r){var i,o,a,s,u,l,c,f,p=[n||C],d=ue.call(e,"type")?e.type:e,h=ue.call(e,"namespace")?e.namespace.split("."):[];if(o=f=a=n=n||C,3!==n.nodeType&&8!==n.nodeType&&!Dt.test(d+ce.event.triggered)&&(-1<d.indexOf(".")&&(d=(h=d.split(".")).shift(),h.sort()),u=d.indexOf(":")<0&&"on"+d,(e=e[ce.expando]?e:new ce.Event(d,"object"==typeof e&&e)).isTrigger=r?2:3,e.namespace=h.join("."),e.rnamespace=e.namespace?new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,e.result=void 0,e.target||(e.target=n),t=null==t?[e]:ce.makeArray(t,[e]),c=ce.event.special[d]||{},r||!c.trigger||!1!==c.trigger.apply(n,t))){if(!r&&!c.noBubble&&!y(n)){for(s=c.delegateType||d,Dt.test(s+d)||(o=o.parentNode);o;o=o.parentNode)p.push(o),a=o;a===(n.ownerDocument||C)&&p.push(a.defaultView||a.parentWindow||ie)}i=0;while((o=p[i++])&&!e.isPropagationStopped())f=o,e.type=1<i?s:c.bindType||d,(l=(_.get(o,"events")||Object.create(null))[e.type]&&_.get(o,"handle"))&&l.apply(o,t),(l=u&&o[u])&&l.apply&&$(o)&&(e.result=l.apply(o,t),!1===e.result&&e.preventDefault());return e.type=d,r||e.isDefaultPrevented()||c._default&&!1!==c._default.apply(p.pop(),t)||!$(n)||u&&v(n[d])&&!y(n)&&((a=n[u])&&(n[u]=null),ce.event.triggered=d,e.isPropagationStopped()&&f.addEventListener(d,Nt),n[d](),e.isPropagationStopped()&&f.removeEventListener(d,Nt),ce.event.triggered=void 0,a&&(n[u]=a)),e.result}},simulate:function(e,t,n){var r=ce.extend(new ce.Event,n,{type:e,isSimulated:!0});ce.event.trigger(r,null,t)}}),ce.fn.extend({trigger:function(e,t){return this.each(function(){ce.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];if(n)return ce.event.trigger(e,t,n,!0)}});var qt=/\[\]$/,Lt=/\r?\n/g,Ht=/^(?:submit|button|image|reset|file)$/i,Ot=/^(?:input|select|textarea|keygen)/i;function Pt(n,e,r,i){var t;if(Array.isArray(e))ce.each(e,function(e,t){r||qt.test(n)?i(n,t):Pt(n+"["+("object"==typeof t&&null!=t?e:"")+"]",t,r,i)});else if(r||"object"!==x(e))i(n,e);else for(t in e)Pt(n+"["+t+"]",e[t],r,i)}ce.param=function(e,t){var n,r=[],i=function(e,t){var n=v(t)?t():t;r[r.length]=encodeURIComponent(e)+"="+encodeURIComponent(null==n?"":n)};if(null==e)return"";if(Array.isArray(e)||e.jquery&&!ce.isPlainObject(e))ce.each(e,function(){i(this.name,this.value)});else for(n in e)Pt(n,e[n],t,i);return r.join("&")},ce.fn.extend({serialize:function(){return ce.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var e=ce.prop(this,"elements");return e?ce.makeArray(e):this}).filter(function(){var e=this.type;return this.name&&!ce(this).is(":disabled")&&Ot.test(this.nodeName)&&!Ht.test(e)&&(this.checked||!we.test(e))}).map(function(e,t){var n=ce(this).val();return null==n?null:Array.isArray(n)?ce.map(n,function(e){return{name:t.name,value:e.replace(Lt,"\r\n")}}):{name:t.name,value:n.replace(Lt,"\r\n")}}).get()}});var Mt=/%20/g,Rt=/#.*$/,It=/([?&])_=[^&]*/,Wt=/^(.*?):[ \t]*([^\r\n]*)$/gm,Ft=/^(?:GET|HEAD)$/,$t=/^\/\//,Bt={},_t={},zt="*/".concat("*"),Xt=C.createElement("a");function Ut(o){return function(e,t){"string"!=typeof e&&(t=e,e="*");var n,r=0,i=e.toLowerCase().match(D)||[];if(v(t))while(n=i[r++])"+"===n[0]?(n=n.slice(1)||"*",(o[n]=o[n]||[]).unshift(t)):(o[n]=o[n]||[]).push(t)}}function Vt(t,i,o,a){var s={},u=t===_t;function l(e){var r;return s[e]=!0,ce.each(t[e]||[],function(e,t){var n=t(i,o,a);return"string"!=typeof n||u||s[n]?u?!(r=n):void 0:(i.dataTypes.unshift(n),l(n),!1)}),r}return l(i.dataTypes[0])||!s["*"]&&l("*")}function Gt(e,t){var n,r,i=ce.ajaxSettings.flatOptions||{};for(n in t)void 0!==t[n]&&((i[n]?e:r||(r={}))[n]=t[n]);return r&&ce.extend(!0,e,r),e}Xt.href=Et.href,ce.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:Et.href,type:"GET",isLocal:/^(?:about|app|app-storage|.+-extension|file|res|widget):$/.test(Et.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":zt,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":ce.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(e,t){return t?Gt(Gt(e,ce.ajaxSettings),t):Gt(ce.ajaxSettings,e)},ajaxPrefilter:Ut(Bt),ajaxTransport:Ut(_t),ajax:function(e,t){"object"==typeof e&&(t=e,e=void 0),t=t||{};var c,f,p,n,d,r,h,g,i,o,v=ce.ajaxSetup({},t),y=v.context||v,m=v.context&&(y.nodeType||y.jquery)?ce(y):ce.event,x=ce.Deferred(),b=ce.Callbacks("once memory"),w=v.statusCode||{},a={},s={},u="canceled",T={readyState:0,getResponseHeader:function(e){var t;if(h){if(!n){n={};while(t=Wt.exec(p))n[t[1].toLowerCase()+" "]=(n[t[1].toLowerCase()+" "]||[]).concat(t[2])}t=n[e.toLowerCase()+" "]}return null==t?null:t.join(", ")},getAllResponseHeaders:function(){return h?p:null},setRequestHeader:function(e,t){return null==h&&(e=s[e.toLowerCase()]=s[e.toLowerCase()]||e,a[e]=t),this},overrideMimeType:function(e){return null==h&&(v.mimeType=e),this},statusCode:function(e){var t;if(e)if(h)T.always(e[T.status]);else for(t in e)w[t]=[w[t],e[t]];return this},abort:function(e){var t=e||u;return c&&c.abort(t),l(0,t),this}};if(x.promise(T),v.url=((e||v.url||Et.href)+"").replace($t,Et.protocol+"//"),v.type=t.method||t.type||v.method||v.type,v.dataTypes=(v.dataType||"*").toLowerCase().match(D)||[""],null==v.crossDomain){r=C.createElement("a");try{r.href=v.url,r.href=r.href,v.crossDomain=Xt.protocol+"//"+Xt.host!=r.protocol+"//"+r.host}catch(e){v.crossDomain=!0}}if(v.data&&v.processData&&"string"!=typeof v.data&&(v.data=ce.param(v.data,v.traditional)),Vt(Bt,v,t,T),h)return T;for(i in(g=ce.event&&v.global)&&0==ce.active++&&ce.event.trigger("ajaxStart"),v.type=v.type.toUpperCase(),v.hasContent=!Ft.test(v.type),f=v.url.replace(Rt,""),v.hasContent?v.data&&v.processData&&0===(v.contentType||"").indexOf("application/x-www-form-urlencoded")&&(v.data=v.data.replace(Mt,"+")):(o=v.url.slice(f.length),v.data&&(v.processData||"string"==typeof v.data)&&(f+=(At.test(f)?"&":"?")+v.data,delete v.data),!1===v.cache&&(f=f.replace(It,"$1"),o=(At.test(f)?"&":"?")+"_="+jt.guid+++o),v.url=f+o),v.ifModified&&(ce.lastModified[f]&&T.setRequestHeader("If-Modified-Since",ce.lastModified[f]),ce.etag[f]&&T.setRequestHeader("If-None-Match",ce.etag[f])),(v.data&&v.hasContent&&!1!==v.contentType||t.contentType)&&T.setRequestHeader("Content-Type",v.contentType),T.setRequestHeader("Accept",v.dataTypes[0]&&v.accepts[v.dataTypes[0]]?v.accepts[v.dataTypes[0]]+("*"!==v.dataTypes[0]?", "+zt+"; q=0.01":""):v.accepts["*"]),v.headers)T.setRequestHeader(i,v.headers[i]);if(v.beforeSend&&(!1===v.beforeSend.call(y,T,v)||h))return T.abort();if(u="abort",b.add(v.complete),T.done(v.success),T.fail(v.error),c=Vt(_t,v,t,T)){if(T.readyState=1,g&&m.trigger("ajaxSend",[T,v]),h)return T;v.async&&0<v.timeout&&(d=ie.setTimeout(function(){T.abort("timeout")},v.timeout));try{h=!1,c.send(a,l)}catch(e){if(h)throw e;l(-1,e)}}else l(-1,"No Transport");function l(e,t,n,r){var i,o,a,s,u,l=t;h||(h=!0,d&&ie.clearTimeout(d),c=void 0,p=r||"",T.readyState=0<e?4:0,i=200<=e&&e<300||304===e,n&&(s=function(e,t,n){var r,i,o,a,s=e.contents,u=e.dataTypes;while("*"===u[0])u.shift(),void 0===r&&(r=e.mimeType||t.getResponseHeader("Content-Type"));if(r)for(i in s)if(s[i]&&s[i].test(r)){u.unshift(i);break}if(u[0]in n)o=u[0];else{for(i in n){if(!u[0]||e.converters[i+" "+u[0]]){o=i;break}a||(a=i)}o=o||a}if(o)return o!==u[0]&&u.unshift(o),n[o]}(v,T,n)),!i&&-1<ce.inArray("script",v.dataTypes)&&ce.inArray("json",v.dataTypes)<0&&(v.converters["text script"]=function(){}),s=function(e,t,n,r){var i,o,a,s,u,l={},c=e.dataTypes.slice();if(c[1])for(a in e.converters)l[a.toLowerCase()]=e.converters[a];o=c.shift();while(o)if(e.responseFields[o]&&(n[e.responseFields[o]]=t),!u&&r&&e.dataFilter&&(t=e.dataFilter(t,e.dataType)),u=o,o=c.shift())if("*"===o)o=u;else if("*"!==u&&u!==o){if(!(a=l[u+" "+o]||l["* "+o]))for(i in l)if((s=i.split(" "))[1]===o&&(a=l[u+" "+s[0]]||l["* "+s[0]])){!0===a?a=l[i]:!0!==l[i]&&(o=s[0],c.unshift(s[1]));break}if(!0!==a)if(a&&e["throws"])t=a(t);else try{t=a(t)}catch(e){return{state:"parsererror",error:a?e:"No conversion from "+u+" to "+o}}}return{state:"success",data:t}}(v,s,T,i),i?(v.ifModified&&((u=T.getResponseHeader("Last-Modified"))&&(ce.lastModified[f]=u),(u=T.getResponseHeader("etag"))&&(ce.etag[f]=u)),204===e||"HEAD"===v.type?l="nocontent":304===e?l="notmodified":(l=s.state,o=s.data,i=!(a=s.error))):(a=l,!e&&l||(l="error",e<0&&(e=0))),T.status=e,T.statusText=(t||l)+"",i?x.resolveWith(y,[o,l,T]):x.rejectWith(y,[T,l,a]),T.statusCode(w),w=void 0,g&&m.trigger(i?"ajaxSuccess":"ajaxError",[T,v,i?o:a]),b.fireWith(y,[T,l]),g&&(m.trigger("ajaxComplete",[T,v]),--ce.active||ce.event.trigger("ajaxStop")))}return T},getJSON:function(e,t,n){return ce.get(e,t,n,"json")},getScript:function(e,t){return ce.get(e,void 0,t,"script")}}),ce.each(["get","post"],function(e,i){ce[i]=function(e,t,n,r){return v(t)&&(r=r||n,n=t,t=void 0),ce.ajax(ce.extend({url:e,type:i,dataType:r,data:t,success:n},ce.isPlainObject(e)&&e))}}),ce.ajaxPrefilter(function(e){var t;for(t in e.headers)"content-type"===t.toLowerCase()&&(e.contentType=e.headers[t]||"")}),ce._evalUrl=function(e,t,n){return ce.ajax({url:e,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,converters:{"text script":function(){}},dataFilter:function(e){ce.globalEval(e,t,n)}})},ce.fn.extend({wrapAll:function(e){var t;return this[0]&&(v(e)&&(e=e.call(this[0])),t=ce(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstElementChild)e=e.firstElementChild;return e}).append(this)),this},wrapInner:function(n){return v(n)?this.each(function(e){ce(this).wrapInner(n.call(this,e))}):this.each(function(){var e=ce(this),t=e.contents();t.length?t.wrapAll(n):e.append(n)})},wrap:function(t){var n=v(t);return this.each(function(e){ce(this).wrapAll(n?t.call(this,e):t)})},unwrap:function(e){return this.parent(e).not("body").each(function(){ce(this).replaceWith(this.childNodes)}),this}}),ce.expr.pseudos.hidden=function(e){return!ce.expr.pseudos.visible(e)},ce.expr.pseudos.visible=function(e){return!!(e.offsetWidth||e.offsetHeight||e.getClientRects().length)},ce.ajaxSettings.xhr=function(){try{return new ie.XMLHttpRequest}catch(e){}};var Yt={0:200,1223:204},Qt=ce.ajaxSettings.xhr();le.cors=!!Qt&&"withCredentials"in Qt,le.ajax=Qt=!!Qt,ce.ajaxTransport(function(i){var o,a;if(le.cors||Qt&&!i.crossDomain)return{send:function(e,t){var n,r=i.xhr();if(r.open(i.type,i.url,i.async,i.username,i.password),i.xhrFields)for(n in i.xhrFields)r[n]=i.xhrFields[n];for(n in i.mimeType&&r.overrideMimeType&&r.overrideMimeType(i.mimeType),i.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest"),e)r.setRequestHeader(n,e[n]);o=function(e){return function(){o&&(o=a=r.onload=r.onerror=r.onabort=r.ontimeout=r.onreadystatechange=null,"abort"===e?r.abort():"error"===e?"number"!=typeof r.status?t(0,"error"):t(r.status,r.statusText):t(Yt[r.status]||r.status,r.statusText,"text"!==(r.responseType||"text")||"string"!=typeof r.responseText?{binary:r.response}:{text:r.responseText},r.getAllResponseHeaders()))}},r.onload=o(),a=r.onerror=r.ontimeout=o("error"),void 0!==r.onabort?r.onabort=a:r.onreadystatechange=function(){4===r.readyState&&ie.setTimeout(function(){o&&a()})},o=o("abort");try{r.send(i.hasContent&&i.data||null)}catch(e){if(o)throw e}},abort:function(){o&&o()}}}),ce.ajaxPrefilter(function(e){e.crossDomain&&(e.contents.script=!1)}),ce.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(e){return ce.globalEval(e),e}}}),ce.ajaxPrefilter("script",function(e){void 0===e.cache&&(e.cache=!1),e.crossDomain&&(e.type="GET")}),ce.ajaxTransport("script",function(n){var r,i;if(n.crossDomain||n.scriptAttrs)return{send:function(e,t){r=ce("<script>").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="<form></form><form></form>",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1<s&&(r=Tt(e.slice(s)),e=e.slice(0,s)),v(t)?(n=t,t=void 0):t&&"object"==typeof t&&(i="POST"),0<a.length&&ce.ajax({url:e,type:i||"GET",dataType:"html",data:t}).done(function(e){o=arguments,a.html(r?ce("<div>").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return M(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return M(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.on("mouseenter",e).on("mouseleave",t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 0<arguments.length?this.on(n,null,e,t):this.trigger(n)}});var en=/^[\s\uFEFF\xA0]+|([^\s\uFEFF\xA0])[\s\uFEFF\xA0]+$/g;ce.proxy=function(e,t){var n,r,i;if("string"==typeof t&&(n=e[t],t=e,e=n),v(e))return r=ae.call(arguments,2),(i=function(){return e.apply(t||this,r.concat(ae.call(arguments)))}).guid=e.guid=e.guid||ce.guid++,i},ce.holdReady=function(e){e?ce.readyWait++:ce.ready(!0)},ce.isArray=Array.isArray,ce.parseJSON=JSON.parse,ce.nodeName=fe,ce.isFunction=v,ce.isWindow=y,ce.camelCase=F,ce.type=x,ce.now=Date.now,ce.isNumeric=function(e){var t=ce.type(e);return("number"===t||"string"===t)&&!isNaN(e-parseFloat(e))},ce.trim=function(e){return null==e?"":(e+"").replace(en,"$1")},"function"==typeof define&&define.amd&&define("jquery",[],function(){return ce});var tn=ie.jQuery,nn=ie.$;return ce.noConflict=function(e){return ie.$===ce&&(ie.$=nn),e&&ie.jQuery===ce&&(ie.jQuery=tn),ce},"undefined"==typeof e&&(ie.jQuery=ie.$=ce),ce}); diff --git a/docs/7.0.X/script-dir/jquery-ui.min.css b/docs/7.0.X/script-dir/jquery-ui.min.css new file mode 100644 index 000000000..693327f01 --- /dev/null +++ b/docs/7.0.X/script-dir/jquery-ui.min.css @@ -0,0 +1,6 @@ +/*! jQuery UI - v1.13.2 - 2023-02-27 +* http://jqueryui.com +* Includes: core.css, autocomplete.css, menu.css +* Copyright jQuery Foundation and other contributors; Licensed MIT */ + +.ui-helper-hidden{display:none}.ui-helper-hidden-accessible{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.ui-helper-reset{margin:0;padding:0;border:0;outline:0;line-height:1.3;text-decoration:none;font-size:100%;list-style:none}.ui-helper-clearfix:before,.ui-helper-clearfix:after{content:"";display:table;border-collapse:collapse}.ui-helper-clearfix:after{clear:both}.ui-helper-zfix{width:100%;height:100%;top:0;left:0;position:absolute;opacity:0;-ms-filter:"alpha(opacity=0)"}.ui-front{z-index:100}.ui-state-disabled{cursor:default!important;pointer-events:none}.ui-icon{display:inline-block;vertical-align:middle;margin-top:-.25em;position:relative;text-indent:-99999px;overflow:hidden;background-repeat:no-repeat}.ui-widget-icon-block{left:50%;margin-left:-8px;display:block}.ui-widget-overlay{position:fixed;top:0;left:0;width:100%;height:100%}.ui-autocomplete{position:absolute;top:0;left:0;cursor:default}.ui-menu{list-style:none;padding:0;margin:0;display:block;outline:0}.ui-menu .ui-menu{position:absolute}.ui-menu .ui-menu-item{margin:0;cursor:pointer;list-style-image:url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")}.ui-menu .ui-menu-item-wrapper{position:relative;padding:3px 1em 3px .4em}.ui-menu .ui-menu-divider{margin:5px 0;height:0;font-size:0;line-height:0;border-width:1px 0 0 0}.ui-menu .ui-state-focus,.ui-menu .ui-state-active{margin:-1px}.ui-menu-icons{position:relative}.ui-menu-icons .ui-menu-item-wrapper{padding-left:2em}.ui-menu .ui-icon{position:absolute;top:0;bottom:0;left:.2em;margin:auto 0}.ui-menu .ui-menu-icon{left:auto;right:0} \ No newline at end of file diff --git a/docs/7.0.X/script-dir/jquery-ui.min.js b/docs/7.0.X/script-dir/jquery-ui.min.js new file mode 100644 index 000000000..8166a15ee --- /dev/null +++ b/docs/7.0.X/script-dir/jquery-ui.min.js @@ -0,0 +1,6 @@ +/*! jQuery UI - v1.13.2 - 2023-02-27 +* http://jqueryui.com +* Includes: widget.js, position.js, keycode.js, unique-id.js, widgets/autocomplete.js, widgets/menu.js +* Copyright jQuery Foundation and other contributors; Licensed MIT */ + +!function(t){"use strict";"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)}(function(x){"use strict";x.ui=x.ui||{};x.ui.version="1.13.2";var n,i=0,l=Array.prototype.hasOwnProperty,a=Array.prototype.slice;x.cleanData=(n=x.cleanData,function(t){for(var e,i,s=0;null!=(i=t[s]);s++)(e=x._data(i,"events"))&&e.remove&&x(i).triggerHandler("remove");n(t)}),x.widget=function(t,i,e){var s,n,o,l={},a=t.split(".")[0],r=a+"-"+(t=t.split(".")[1]);return e||(e=i,i=x.Widget),Array.isArray(e)&&(e=x.extend.apply(null,[{}].concat(e))),x.expr.pseudos[r.toLowerCase()]=function(t){return!!x.data(t,r)},x[a]=x[a]||{},s=x[a][t],n=x[a][t]=function(t,e){if(!this||!this._createWidget)return new n(t,e);arguments.length&&this._createWidget(t,e)},x.extend(n,s,{version:e.version,_proto:x.extend({},e),_childConstructors:[]}),(o=new i).options=x.widget.extend({},o.options),x.each(e,function(e,s){function n(){return i.prototype[e].apply(this,arguments)}function o(t){return i.prototype[e].apply(this,t)}l[e]="function"==typeof s?function(){var t,e=this._super,i=this._superApply;return this._super=n,this._superApply=o,t=s.apply(this,arguments),this._super=e,this._superApply=i,t}:s}),n.prototype=x.widget.extend(o,{widgetEventPrefix:s&&o.widgetEventPrefix||t},l,{constructor:n,namespace:a,widgetName:t,widgetFullName:r}),s?(x.each(s._childConstructors,function(t,e){var i=e.prototype;x.widget(i.namespace+"."+i.widgetName,n,e._proto)}),delete s._childConstructors):i._childConstructors.push(n),x.widget.bridge(t,n),n},x.widget.extend=function(t){for(var e,i,s=a.call(arguments,1),n=0,o=s.length;n<o;n++)for(e in s[n])i=s[n][e],l.call(s[n],e)&&void 0!==i&&(x.isPlainObject(i)?t[e]=x.isPlainObject(t[e])?x.widget.extend({},t[e],i):x.widget.extend({},i):t[e]=i);return t},x.widget.bridge=function(o,e){var l=e.prototype.widgetFullName||o;x.fn[o]=function(i){var t="string"==typeof i,s=a.call(arguments,1),n=this;return t?this.length||"instance"!==i?this.each(function(){var t,e=x.data(this,l);return"instance"===i?(n=e,!1):e?"function"!=typeof e[i]||"_"===i.charAt(0)?x.error("no such method '"+i+"' for "+o+" widget instance"):(t=e[i].apply(e,s))!==e&&void 0!==t?(n=t&&t.jquery?n.pushStack(t.get()):t,!1):void 0:x.error("cannot call methods on "+o+" prior to initialization; attempted to call method '"+i+"'")}):n=void 0:(s.length&&(i=x.widget.extend.apply(null,[i].concat(s))),this.each(function(){var t=x.data(this,l);t?(t.option(i||{}),t._init&&t._init()):x.data(this,l,new e(i,this))})),n}},x.Widget=function(){},x.Widget._childConstructors=[],x.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"<div>",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n<i.length-1;n++)s[i[n]]=s[i[n]]||{},s=s[i[n]];if(t=i.pop(),1===arguments.length)return void 0===s[t]?null:s[t];s[t]=e}else{if(1===arguments.length)return void 0===this.options[t]?null:this.options[t];o[t]=e}return this._setOptions(o),this},_setOptions:function(t){for(var e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(t){var e,i,s;for(e in t)s=this.classesElementLookup[e],t[e]!==this.options.classes[e]&&s&&s.length&&(i=x(s.get()),this._removeClass(s,e),i.addClass(this._classes({element:i,keys:e,classes:t,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(n){var o=[],l=this;function t(t,e){for(var i,s=0;s<t.length;s++)i=l.classesElementLookup[t[s]]||x(),i=n.add?(function(){var i=[];n.element.each(function(t,e){x.map(l.classesElementLookup,function(t){return t}).some(function(t){return t.is(e)})||i.push(e)}),l._on(x(i),{remove:"_untrackClassesElement"})}(),x(x.uniqueSort(i.get().concat(n.element.get())))):x(i.not(n.element).get()),l.classesElementLookup[t[s]]=i,o.push(t[s]),e&&n.classes[t[s]]&&o.push(n.classes[t[s]])}return(n=x.extend({element:this.element,classes:this.options.classes||{}},n)).keys&&t(n.keys.match(/\S+/g)||[],!0),n.extra&&t(n.extra.match(/\S+/g)||[]),o.join(" ")},_untrackClassesElement:function(i){var s=this;x.each(s.classesElementLookup,function(t,e){-1!==x.inArray(i.target,e)&&(s.classesElementLookup[t]=x(e.not(i.target).get()))}),this._off(x(i.target))},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){var n="string"==typeof t||null===t,i={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s="boolean"==typeof s?s:i};return i.element.toggleClass(this._classes(i),s),this},_on:function(n,o,t){var l,a=this;"boolean"!=typeof n&&(t=o,o=n,n=!1),t?(o=l=x(o),this.bindings=this.bindings.add(o)):(t=o,o=this.element,l=this.widget()),x.each(t,function(t,e){function i(){if(n||!0!==a.options.disabled&&!x(this).hasClass("ui-state-disabled"))return("string"==typeof e?a[e]:e).apply(a,arguments)}"string"!=typeof e&&(i.guid=e.guid=e.guid||i.guid||x.guid++);var s=t.match(/^([\w:-]*)\s*(.*)$/),t=s[1]+a.eventNamespace,s=s[2];s?l.on(t,s,i):o.on(t,i)})},_off:function(t,e){e=(e||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,t.off(e),this.bindings=x(this.bindings.not(t).get()),this.focusable=x(this.focusable.not(t).get()),this.hoverable=x(this.hoverable.not(t).get())},_delay:function(t,e){var i=this;return setTimeout(function(){return("string"==typeof t?i[t]:t).apply(i,arguments)},e||0)},_hoverable:function(t){this.hoverable=this.hoverable.add(t),this._on(t,{mouseenter:function(t){this._addClass(x(t.currentTarget),null,"ui-state-hover")},mouseleave:function(t){this._removeClass(x(t.currentTarget),null,"ui-state-hover")}})},_focusable:function(t){this.focusable=this.focusable.add(t),this._on(t,{focusin:function(t){this._addClass(x(t.currentTarget),null,"ui-state-focus")},focusout:function(t){this._removeClass(x(t.currentTarget),null,"ui-state-focus")}})},_trigger:function(t,e,i){var s,n,o=this.options[t];if(i=i||{},(e=x.Event(e)).type=(t===this.widgetEventPrefix?t:this.widgetEventPrefix+t).toLowerCase(),e.target=this.element[0],n=e.originalEvent)for(s in n)s in e||(e[s]=n[s]);return this.element.trigger(e,i),!("function"==typeof o&&!1===o.apply(this.element[0],[e].concat(i))||e.isDefaultPrevented())}},x.each({show:"fadeIn",hide:"fadeOut"},function(o,l){x.Widget.prototype["_"+o]=function(e,t,i){var s,n=(t="string"==typeof t?{effect:t}:t)?!0!==t&&"number"!=typeof t&&t.effect||l:o;"number"==typeof(t=t||{})?t={duration:t}:!0===t&&(t={}),s=!x.isEmptyObject(t),t.complete=i,t.delay&&e.delay(t.delay),s&&x.effects&&x.effects.effect[n]?e[o](t):n!==o&&e[n]?e[n](t.duration,t.easing,i):e.queue(function(t){x(this)[o](),i&&i.call(e[0]),t()})}});var s,C,E,o,r,u,h,c,k;x.widget;function T(t,e,i){return[parseFloat(t[0])*(c.test(t[0])?e/100:1),parseFloat(t[1])*(c.test(t[1])?i/100:1)]}function A(t,e){return parseInt(x.css(t,e),10)||0}function W(t){return null!=t&&t===t.window}C=Math.max,E=Math.abs,o=/left|center|right/,r=/top|center|bottom/,u=/[\+\-]\d+(\.[\d]+)?%?/,h=/^\w+/,c=/%$/,k=x.fn.position,x.position={scrollbarWidth:function(){if(void 0!==s)return s;var t,e=x("<div style='display:block;position:absolute;width:200px;height:200px;overflow:hidden;'><div style='height:300px;width:auto;'></div></div>"),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.width<t.element[0].scrollWidth;return{width:"scroll"===i||"auto"===i&&t.height<t.element[0].scrollHeight?x.position.scrollbarWidth():0,height:e?x.position.scrollbarWidth():0}},getWithinInfo:function(t){var e=x(t||window),i=W(e[0]),s=!!e[0]&&9===e[0].nodeType;return{element:e,isWindow:i,isDocument:s,offset:!i&&!s?x(t).offset():{left:0,top:0},scrollLeft:e.scrollLeft(),scrollTop:e.scrollTop(),width:e.outerWidth(),height:e.outerHeight()}}},x.fn.position=function(c){if(!c||!c.of)return k.apply(this,arguments);var d,f,m,p,v,t,g="string"==typeof(c=x.extend({},c)).of?x(document).find(c.of):x(c.of),_=x.position.getWithinInfo(c.within),y=x.position.getScrollInfo(_),b=(c.collision||"flip").split(" "),w={},e=9===(t=(e=g)[0]).nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:W(t)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:t.preventDefault?{width:0,height:0,offset:{top:t.pageY,left:t.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()};return g[0].preventDefault&&(c.at="left top"),f=e.width,m=e.height,v=x.extend({},p=e.offset),x.each(["my","at"],function(){var t,e,i=(c[this]||"").split(" ");(i=1===i.length?o.test(i[0])?i.concat(["center"]):r.test(i[0])?["center"].concat(i):["center","center"]:i)[0]=o.test(i[0])?i[0]:"center",i[1]=r.test(i[1])?i[1]:"center",t=u.exec(i[0]),e=u.exec(i[1]),w[this]=[t?t[0]:0,e?e[0]:0],c[this]=[h.exec(i[0])[0],h.exec(i[1])[0]]}),1===b.length&&(b[1]=b[0]),"right"===c.at[0]?v.left+=f:"center"===c.at[0]&&(v.left+=f/2),"bottom"===c.at[1]?v.top+=m:"center"===c.at[1]&&(v.top+=m/2),d=T(w.at,f,m),v.left+=d[0],v.top+=d[1],this.each(function(){var i,t,l=x(this),a=l.outerWidth(),r=l.outerHeight(),e=A(this,"marginLeft"),s=A(this,"marginTop"),n=a+e+A(this,"marginRight")+y.width,o=r+s+A(this,"marginBottom")+y.height,u=x.extend({},v),h=T(w.my,l.outerWidth(),l.outerHeight());"right"===c.my[0]?u.left-=a:"center"===c.my[0]&&(u.left-=a/2),"bottom"===c.my[1]?u.top-=r:"center"===c.my[1]&&(u.top-=r/2),u.left+=h[0],u.top+=h[1],i={marginLeft:e,marginTop:s},x.each(["left","top"],function(t,e){x.ui.position[b[t]]&&x.ui.position[b[t]][e](u,{targetWidth:f,targetHeight:m,elemWidth:a,elemHeight:r,collisionPosition:i,collisionWidth:n,collisionHeight:o,offset:[d[0]+h[0],d[1]+h[1]],my:c.my,at:c.at,within:_,elem:l})}),c.using&&(t=function(t){var e=p.left-u.left,i=e+f-a,s=p.top-u.top,n=s+m-r,o={target:{element:g,left:p.left,top:p.top,width:f,height:m},element:{element:l,left:u.left,top:u.top,width:a,height:r},horizontal:i<0?"left":0<e?"right":"center",vertical:n<0?"top":0<s?"bottom":"middle"};f<a&&E(e+i)<f&&(o.horizontal="center"),m<r&&E(s+n)<m&&(o.vertical="middle"),C(E(e),E(i))>C(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0<l&&a<=0?(i=t.left+l+e.collisionWidth-n-s,t.left+=l-i):t.left=!(0<a&&l<=0)&&a<l?s+n-e.collisionWidth:s:0<l?t.left+=l:0<a?t.left-=a:t.left=C(t.left-o,t.left)},top:function(t,e){var i=e.within,s=i.isWindow?i.scrollTop:i.offset.top,n=e.within.height,o=t.top-e.collisionPosition.marginTop,l=s-o,a=o+e.collisionHeight-n-s;e.collisionHeight>n?0<l&&a<=0?(i=t.top+l+e.collisionHeight-n-s,t.top+=l-i):t.top=!(0<a&&l<=0)&&a<l?s+n-e.collisionHeight:s:0<l?t.top+=l:0<a?t.top-=a:t.top=C(t.top-o,t.top)}},flip:{left:function(t,e){var i=e.within,s=i.offset.left+i.scrollLeft,n=i.width,o=i.isWindow?i.scrollLeft:i.offset.left,l=t.left-e.collisionPosition.marginLeft,a=l-o,r=l+e.collisionWidth-n-o,u="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,i="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,l=-2*e.offset[0];a<0?((s=t.left+u+i+l+e.collisionWidth-n-s)<0||s<E(a))&&(t.left+=u+i+l):0<r&&(0<(o=t.left-e.collisionPosition.marginLeft+u+i+l-o)||E(o)<r)&&(t.left+=u+i+l)},top:function(t,e){var i=e.within,s=i.offset.top+i.scrollTop,n=i.height,o=i.isWindow?i.scrollTop:i.offset.top,l=t.top-e.collisionPosition.marginTop,a=l-o,r=l+e.collisionHeight-n-o,u="top"===e.my[1]?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,i="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,l=-2*e.offset[1];a<0?((s=t.top+u+i+l+e.collisionHeight-n-s)<0||s<E(a))&&(t.top+=u+i+l):0<r&&(0<(o=t.top-e.collisionPosition.marginTop+u+i+l-o)||E(o)<r)&&(t.top+=u+i+l)}},flipfit:{left:function(){x.ui.position.flip.left.apply(this,arguments),x.ui.position.fit.left.apply(this,arguments)},top:function(){x.ui.position.flip.top.apply(this,arguments),x.ui.position.fit.top.apply(this,arguments)}}};var t;x.ui.position,x.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},x.fn.extend({uniqueId:(t=0,function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&x(this).removeAttr("id")})}}),x.ui.safeActiveElement=function(e){var i;try{i=e.activeElement}catch(t){i=e.body}return i=!(i=i||e.body).nodeName?e.body:i},x.widget("ui.menu",{version:"1.13.2",defaultElement:"<ul>",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("<span>").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s<e+t&&this.activeMenu.scrollTop(i+e-s+t))},blur:function(t,e){e||clearTimeout(this.timer),this.active&&(this._removeClass(this.active.children(".ui-menu-item-wrapper"),null,"ui-state-active"),this._trigger("blur",t,{item:this.active}),this.active=null)},_startOpening:function(t){clearTimeout(this.timer),"true"===t.attr("aria-hidden")&&(this.timer=this._delay(function(){this._close(),this._open(t)},this.delay))},_open:function(t){var e=x.extend({of:this.active},this.options.position);clearTimeout(this.timer),this.element.find(".ui-menu").not(t.parents(".ui-menu")).hide().attr("aria-hidden","true"),t.show().removeAttr("aria-hidden").attr("aria-expanded","true").position(e)},collapseAll:function(e,i){clearTimeout(this.timer),this.timer=this._delay(function(){var t=i?this.element:x(e&&e.target).closest(this.element.find(".ui-menu"));t.length||(t=this.element),this._close(t),this.blur(e),this._removeClass(t.find(".ui-state-active"),null,"ui-state-active"),this.activeMenu=t},i?0:this.delay)},_close:function(t){(t=t||(this.active?this.active.parent():this.element)).find(".ui-menu").hide().attr("aria-hidden","true").attr("aria-expanded","false")},_closeOnDocumentClick:function(t){return!x(t.target).closest(".ui-menu").length},_isDivider:function(t){return!/[^\-\u2014\u2013\s]/.test(t.text())},collapse:function(t){var e=this.active&&this.active.parent().closest(".ui-menu-item",this.element);e&&e.length&&(this._close(),this.focus(t,e))},expand:function(t){var e=this.active&&this._menuItems(this.active.children(".ui-menu")).first();e&&e.length&&(this._open(e.parent()),this._delay(function(){this.focus(t,e)}))},next:function(t){this._move("next","first",t)},previous:function(t){this._move("prev","last",t)},isFirstItem:function(){return this.active&&!this.active.prevAll(".ui-menu-item").length},isLastItem:function(){return this.active&&!this.active.nextAll(".ui-menu-item").length},_menuItems:function(t){return(t||this.element).find(this.options.items).filter(".ui-menu-item")},_move:function(t,e,i){var s;(s=this.active?"first"===t||"last"===t?this.active["first"===t?"prevAll":"nextAll"](".ui-menu-item").last():this.active[t+"All"](".ui-menu-item").first():s)&&s.length&&this.active||(s=this._menuItems(this.activeMenu)[e]()),this.focus(i,s)},nextPage:function(t){var e,i,s;this.active?this.isLastItem()||(this._hasScroll()?(i=this.active.offset().top,s=this.element.innerHeight(),0===x.fn.jquery.indexOf("3.2.")&&(s+=this.element[0].offsetHeight-this.element.outerHeight()),this.active.nextAll(".ui-menu-item").each(function(){return(e=x(this)).offset().top-i-s<0}),this.focus(t,e)):this.focus(t,this._menuItems(this.activeMenu)[this.active?"last":"first"]())):this.next(t)},previousPage:function(t){var e,i,s;this.active?this.isFirstItem()||(this._hasScroll()?(i=this.active.offset().top,s=this.element.innerHeight(),0===x.fn.jquery.indexOf("3.2.")&&(s+=this.element[0].offsetHeight-this.element.outerHeight()),this.active.prevAll(".ui-menu-item").each(function(){return 0<(e=x(this)).offset().top-i+s}),this.focus(t,e)):this.focus(t,this._menuItems(this.activeMenu).first())):this.next(t)},_hasScroll:function(){return this.element.outerHeight()<this.element.prop("scrollHeight")},select:function(t){this.active=this.active||x(t.target).closest(".ui-menu-item");var e={item:this.active};this.active.has(".ui-menu").length||this.collapseAll(t,!0),this._trigger("select",t,e)},_filterMenuItems:function(t){var t=t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&"),e=new RegExp("^"+t,"i");return this.activeMenu.find(this.options.items).filter(".ui-menu-item").filter(function(){return e.test(String.prototype.trim.call(x(this).children(".ui-menu-item-wrapper").text()))})}});x.widget("ui.autocomplete",{version:"1.13.2",defaultElement:"<input>",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("<ul>").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("<div>").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("<div>",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length<this.options.minLength?this.close(e):!1!==this._trigger("search",e)?this._search(t):void 0},_search:function(t){this.pending++,this._addClass("ui-autocomplete-loading"),this.cancelSearch=!1,this.source({term:t},this._response())},_response:function(){var e=++this.requestIndex;return function(t){e===this.requestIndex&&this.__response(t),this.pending--,this.pending||this._removeClass("ui-autocomplete-loading")}.bind(this)},__response:function(t){t=t&&this._normalize(t),this._trigger("response",null,{content:t}),!this.options.disabled&&t&&t.length&&!this.cancelSearch?(this._suggest(t),this._trigger("open")):this._close()},close:function(t){this.cancelSearch=!0,this._close(t)},_close:function(t){this._off(this.document,"mousedown"),this.menu.element.is(":visible")&&(this.menu.element.hide(),this.menu.blur(),this.isNewMenu=!0,this._trigger("close",t))},_change:function(t){this.previous!==this._value()&&this._trigger("change",t,{item:this.selectedItem})},_normalize:function(t){return t.length&&t[0].label&&t[0].value?t:x.map(t,function(t){return"string"==typeof t?{label:t,value:t}:x.extend({},t,{label:t.label||t.value,value:t.value||t.label})})},_suggest:function(t){var e=this.menu.element.empty();this._renderMenu(e,t),this.isNewMenu=!0,this.menu.refresh(),e.show(),this._resizeMenu(),e.position(x.extend({of:this.element},this.options.position)),this.options.autoFocus&&this.menu.next(),this._on(this.document,{mousedown:"_closeOnClickOutside"})},_resizeMenu:function(){var t=this.menu.element;t.outerWidth(Math.max(t.width("").outerWidth()+1,this.element.outerWidth()))},_renderMenu:function(i,t){var s=this;x.each(t,function(t,e){s._renderItemData(i,e)})},_renderItemData:function(t,e){return this._renderItem(t,e).data("ui-autocomplete-item",e)},_renderItem:function(t,e){return x("<li>").append(x("<div>").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1<t?" results are":" result is")+" available, use up and down arrow keys to navigate."}}},__response:function(t){var e;this._superApply(arguments),this.options.disabled||this.cancelSearch||(e=t&&t.length?this.options.messages.results(t.length):this.options.messages.noResults,clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("<div>").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/docs/7.0.X/script.js b/docs/7.0.X/script.js new file mode 100644 index 000000000..73cd8faac --- /dev/null +++ b/docs/7.0.X/script.js @@ -0,0 +1,132 @@ +/* + * Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor); + elem.classList.add(isEvenRow ? evenRowColor : oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.getElementById(tableId + '.tabpanel') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} + +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + contentDiv.addEventListener("scroll", function(e) { + var timeoutID; + if (!timeoutID) { + timeoutID = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + timeoutID = null; + }, 100); + } + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/docs/7.0.X/search.js b/docs/7.0.X/search.js new file mode 100644 index 000000000..db3b2f4a6 --- /dev/null +++ b/docs/7.0.X/search.js @@ -0,0 +1,354 @@ +/* + * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var loading = {l: "Loading search index..."}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Classes and Interfaces"; +var catMembers = "Members"; +var catSearchTags = "Search Tags"; +var highlight = "<span class=\"result-highlight\">$&</span>"; +var searchPattern = ""; +var fallbackPattern = ""; +var RANKING_THRESHOLD = 2; +var NO_MATCH = 0xffff; +var MIN_RESULTS = 3; +var MAX_RESULTS = 500; +var UNNAMED = "<Unnamed>"; +function escapeHtml(str) { + return str.replace(/</g, "<").replace(/>/g, ">"); +} +function getHighlightedText(item, matcher, fallbackMatcher) { + var escapedItem = escapeHtml(item); + var highlighted = escapedItem.replace(matcher, highlight); + if (highlighted === escapedItem) { + highlighted = escapedItem.replace(fallbackMatcher, highlight) + } + return highlighted; +} +function getURLPrefix(ui) { + var urlPrefix=""; + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if (ui.item.category === catTypes || ui.item.category === catMembers) { + if (ui.item.m) { + urlPrefix = ui.item.m + slash; + } else { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p === item.l) { + urlPrefix = item.m + slash; + } + }); + } + } + return urlPrefix; +} +function createSearchPattern(term) { + var pattern = ""; + var isWordToken = false; + term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) { + if (index > 0) { + // whitespace between identifiers is significant + pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*"; + } + var tokens = w.split(/(?=[A-Z,.()<>[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + if (s === "") { + continue; + } + pattern += $.ui.autocomplete.escapeRegex(s); + isWordToken = /\w$/.test(s); + if (isWordToken) { + pattern += "([a-z0-9_$<>\\[\\]]*?)"; + } + } + }); + return pattern; +} +function createMatcher(pattern, flags) { + var isCamelCase = /[A-Z]/.test(pattern); + return new RegExp(pattern, flags + (isCamelCase ? "" : "i")); +} +var watermark = 'Search'; +$(function() { + var search = $("#search-input"); + var reset = $("#reset-button"); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + search.val(watermark).addClass('watermark'); + search.blur(function() { + if ($(this).val().length === 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + search.on('click keydown paste', function() { + if ($(this).val() === watermark) { + $(this).val('').removeClass('watermark'); + } + }); + reset.click(function() { + search.val('').focus(); + }); + search.focus()[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this; + var currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.category && item.category !== currentCategory) { + ul.append("<li class=\"ui-autocomplete-category\">" + item.category + "</li>"); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "result-item"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "result-item"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + var matcher = createMatcher(escapeHtml(searchPattern), "g"); + var fallbackMatcher = new RegExp(fallbackPattern, "gi") + if (item.category === catModules) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catPackages) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catTypes) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catMembers) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else { + label = item.l; + } + var li = $("<li/>").appendTo(ul); + var div = $("<div/>").appendTo(li); + if (item.category === catSearchTags && item.h) { + if (item.d) { + div.html(label + "<span class=\"search-tag-holder-result\"> (" + item.h + ")</span><br><span class=\"search-tag-desc-result\">" + + item.d + "</span><br>"); + } else { + div.html(label + "<span class=\"search-tag-holder-result\"> (" + item.h + ")</span>"); + } + } else { + if (item.m) { + div.html(item.m + "/" + label); + } else { + div.html(label); + } + } + return li; + } +}); +function rankMatch(match, category) { + if (!match) { + return NO_MATCH; + } + var index = match.index; + var input = match.input; + var leftBoundaryMatch = 2; + var periferalMatch = 0; + // make sure match is anchored on a left word boundary + if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) { + leftBoundaryMatch = 0; + } else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) { + leftBoundaryMatch = 1; + } + var matchEnd = index + match[0].length; + var leftParen = input.indexOf("("); + var endOfName = leftParen > -1 ? leftParen : input.length; + // exclude peripheral matches + if (category !== catModules && category !== catSearchTags) { + var delim = category === catPackages ? "/" : "."; + if (leftParen > -1 && leftParen < index) { + periferalMatch += 2; + } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) { + periferalMatch += 2; + } + } + var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match + for (var i = 1; i < match.length; i++) { + // lower ranking if parts of the name are missing + if (match[i]) + delta += match[i].length; + } + if (category === catTypes) { + // lower ranking if a type name contains unmatched camel-case parts + if (/[A-Z]/.test(input.substring(matchEnd))) + delta += 5; + if (/[A-Z]/.test(input.substring(0, index))) + delta += 5; + } + return leftBoundaryMatch + periferalMatch + (delta / 200); + +} +function doSearch(request, response) { + var result = []; + searchPattern = createSearchPattern(request.term); + fallbackPattern = createSearchPattern(request.term.toLowerCase()); + if (searchPattern === "") { + return this.close(); + } + var camelCaseMatcher = createMatcher(searchPattern, ""); + var fallbackMatcher = new RegExp(fallbackPattern, "i"); + + function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) { + if (indexArray) { + var newResults = []; + $.each(indexArray, function (i, item) { + item.category = category; + var ranking = rankMatch(matcher.exec(nameFunc(item)), category); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ranking: ranking, item: item}); + } + return newResults.length <= MAX_RESULTS; + }); + return newResults.sort(function(e1, e2) { + return e1.ranking - e2.ranking; + }).map(function(e) { + return e.item; + }); + } + return []; + } + function searchIndex(indexArray, category, nameFunc) { + var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc); + result = result.concat(primaryResults); + if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) { + var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc); + result = result.concat(secondaryResults.filter(function (item) { + return primaryResults.indexOf(item) === -1; + })); + } + } + + searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; }); + searchIndex(packageSearchIndex, catPackages, function(item) { + return (item.m && request.term.indexOf("/") > -1) + ? (item.m + "/" + item.l) : item.l; + }); + searchIndex(typeSearchIndex, catTypes, function(item) { + return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l; + }); + searchIndex(memberSearchIndex, catMembers, function(item) { + return request.term.indexOf(".") > -1 + ? item.p + "." + item.c + "." + item.l : item.l; + }); + searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; }); + + if (!indexFilesLoaded()) { + updateSearchResults = function() { + doSearch(request, response); + } + result.unshift(loading); + } else { + updateSearchResults = function() {}; + } + response(result); +} +$(function() { + $("#search-input").catcomplete({ + minLength: 1, + delay: 300, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.category) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + url += "module-summary.html"; + } else if (ui.item.category === catPackages) { + if (ui.item.u) { + url = ui.item.u; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.u) { + url = ui.item.u; + } else if (ui.item.p === UNNAMED) { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === UNNAMED) { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.u) { + url += ui.item.u; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search-input").focus(); + } + } + }); +}); diff --git a/docs/7.0.X/serialized-form.html b/docs/7.0.X/serialized-form.html new file mode 100644 index 000000000..6f16f73c1 --- /dev/null +++ b/docs/7.0.X/serialized-form.html @@ -0,0 +1,128 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>Serialized Form (datasketches-java 7.0.0 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="serialized forms"> +<meta name="generator" content="javadoc/SerializedFormWriterImpl"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="serialized-form-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-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#serialized-form">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 title="Serialized Form" class="title">Serialized Form</h1> +</div> +<ul class="block-list"> +<li> +<section class="serialized-package-container"> +<h2 title="Package">Package <a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></h2> +<ul class="block-list"> +<li> +<section class="serialized-class-details" id="org.apache.datasketches.common.SketchesArgumentException"> +<h3>Exception <a href="org/apache/datasketches/common/SketchesArgumentException.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.SketchesArgumentException</a></h3> +<div class="type-signature">class SketchesArgumentException extends <a href="org/apache/datasketches/common/SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a> implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> +<dl class="name-value"> +<dt>serialVersionUID:</dt> +<dd>1L</dd> +</dl> +</section> +</li> +<li> +<section class="serialized-class-details" id="org.apache.datasketches.common.SketchesException"> +<h3>Exception <a href="org/apache/datasketches/common/SketchesException.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.SketchesException</a></h3> +<div class="type-signature">class SketchesException extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a> implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> +<dl class="name-value"> +<dt>serialVersionUID:</dt> +<dd>1L</dd> +</dl> +</section> +</li> +<li> +<section class="serialized-class-details" id="org.apache.datasketches.common.SketchesReadOnlyException"> +<h3>Exception <a href="org/apache/datasketches/common/SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.SketchesReadOnlyException</a></h3> +<div class="type-signature">class SketchesReadOnlyException extends <a href="org/apache/datasketches/common/SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a> implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> +<dl class="name-value"> +<dt>serialVersionUID:</dt> +<dd>1L</dd> +</dl> +</section> +</li> +<li> +<section class="serialized-class-details" id="org.apache.datasketches.common.SketchesStateException"> +<h3>Exception <a href="org/apache/datasketches/common/SketchesStateException.html" title="class in org.apache.datasketches.common">org.apache.datasketches.common.SketchesStateException</a></h3> +<div class="type-signature">class SketchesStateException extends <a href="org/apache/datasketches/common/SketchesException.html" title="class in org.apache.datasketches.common">SketchesException</a> implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> +<dl class="name-value"> +<dt>serialVersionUID:</dt> +<dd>1L</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<li> +<section class="serialized-package-container"> +<h2 title="Package">Package <a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a></h2> +<ul class="block-list"> +<li> +<section class="serialized-class-details" id="org.apache.datasketches.hash.MurmurHash3"> +<h3>Class <a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">org.apache.datasketches.hash.MurmurHash3</a></h3> +<div class="type-signature">class MurmurHash3 extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> +<dl class="name-value"> +<dt>serialVersionUID:</dt> +<dd>0L</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2015–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> diff --git a/docs/7.0.X/stylesheet.css b/docs/7.0.X/stylesheet.css new file mode 100644 index 000000000..4a576bd24 --- /dev/null +++ b/docs/7.0.X/stylesheet.css @@ -0,0 +1,869 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; +} +h4 { + font-size:15px; +} +h5 { + font-size:14px; +} +h6 { + font-size:13px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +.summary-table dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size: 14px; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0; + overflow:hidden; +} +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:11px; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +@media screen { + .flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + .flex-header { + flex: 0 0 auto; + } + .flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + min-height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.sub-nav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.sub-nav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list { + padding-top:5px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0 0 0 0; + padding:5px 6px; + clear:none; +} +.nav-list-search label { + position:relative; + right:-16px; +} +ul.sub-nav-list li { + list-style:none; + float:left; + padding-top:10px; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.nav-bar-cell1-rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header and footer. + */ +.title { + color:#2c4557; + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.see-list, ul.see-list-long { + padding-left: 0; + list-style: none; +} +ul.see-list li { + display: inline; +} +ul.see-list li:not(:last-child):after, +ul.see-list-long li:not(:last-child):after { + content: ", "; + white-space: pre-wrap; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0; + padding-top:10px; + padding-left:1px; + margin:0; + white-space:pre; +} +.caption a:link, .caption a:visited { + color:#1f389c; +} +.caption a:hover, +.caption a:active { + color:#FFFFFF; +} +.caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; +} +div.table-tabs > button.active-table-tab { + background: #F8981D; + color: #253441; +} +div.table-tabs > button.table-tab { + background: #4D7A97; + color: #FFFFFF; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto); +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +@media screen and (max-width: 800px) { + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-summary .col-last { + grid-column-end: span 2; + } +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:#dee3e9; + font-weight: bold; +} +.col-first, .col-first { + font-size:13px; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:13px; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited, +.constant-values-container a:link, .constant-values-container a:visited, +.all-classes-container a:link, .all-classes-container a:visited, +.all-packages-container a:link, .all-packages-container a:visited { + font-weight:bold; +} +.table-sub-heading-color { + background-color:#EEEEFF; +} +.even-row-color, .even-row-color .table-header { + background-color:#FFFFFF; +} +.odd-row-color, .odd-row-color .table-header { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.deprecated-content { + margin:0; + padding:10px 0; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:0 10px 5px 0; + color:#474747; +} +.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.result-item { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.result-highlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; + width:400px; +} +#reset-button { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:16px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:yellow; +} +.module-graph span { + display:none; + position:absolute; +} +.module-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0px 20px 5px 10px; + border: 1px solid #ededed; + background-color: #f8f8f8; +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +span.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + <svg xmlns="http://www.w3.org/2000/svg" width="768" height="768">\ + <path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \ + 132-240 240 120 120 240-240 132 132V0z" fill="%234a6782"/>\ + </svg>'); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + <svg xmlns="http://www.w3.org/2000/svg" width="768" height="768">\ + <path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \ + 132-240 240 120 120 240-240 132 132V0z" fill="%23bb7a2a"/>\ + </svg>'); +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak font sizes and paddings for small screens. + */ +@media screen and (max-width: 1050px) { + #search-input { + width: 300px; + } +} +@media screen and (max-width: 800px) { + #search-input { + width: 200px; + } + .top-nav, + .bottom-nav { + font-size: 11px; + padding-top: 6px; + } + .sub-nav { + font-size: 11px; + } + .about-language { + padding-right: 16px; + } + ul.nav-list li, + .sub-nav .nav-list-search { + padding: 6px; + } + ul.sub-nav-list li { + padding-top: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 500px) { + #search-input { + width: 150px; + } + .top-nav, + .bottom-nav { + font-size: 10px; + } + .sub-nav { + font-size: 10px; + } + .about-language { + font-size: 10px; + padding-right: 12px; + } +} diff --git a/docs/7.0.X/tag-search-index.js b/docs/7.0.X/tag-search-index.js new file mode 100644 index 000000000..bf10aaf6d --- /dev/null +++ b/docs/7.0.X/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Constant Field Values","h":"","u":"constant-values.html"},{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/7.0.X/type-search-index.js b/docs/7.0.X/type-search-index.js new file mode 100644 index 000000000..aa6ab2acd --- /dev/null +++ b/docs/7.0.X/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.apache.datasketches.theta","l":"AnotB"},{"p":"org.apache.datasketches.tuple","l":"AnotB"},{"p":"org.apache.datasketches.thetacommon","l":"SetOperationCornerCases.AnotbAction"},{"p":"org.apache.datasketches.common","l":"ArrayOfBooleansSerDe"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesAnotB"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesAnotBImpl"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesCombiner"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesCompactSketch"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesIntersection"},{"p":"org.apache.datasketches.common","l":"ArrayOfDoublesSerDe"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesSetOperationBuilder"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesSketch"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesSketches"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesSketchIterator"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesUnion"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesUpdatableSketch"},{"p":"org.apache.datasketches.tuple.arrayofdoubles","l":"ArrayOfDoublesUpdatableSketchBuilder"},{"p":"org.apache.datasketches.common","l":"ArrayOfItemsSerDe"},{"p":"org.apache.datasketches.common","l":"ArrayOfLongsSerDe"},{"p":"org.apache.datasketches.common","l":"ArrayOfNumbersSerDe"},{"p":"org.apache.datasketches.common","l":"ArrayOfStringsSerDe"},{"p":"org.apache.datasketches.tuple.strings","l":"ArrayOfStringsSketch"},{"p":"org.apache.datasketches.tuple.strings","l":"ArrayOfStringsSummary"},{"p":"org.apache.datasketches.tuple.strings","l":"ArrayOfStringsSummaryDeserializer"},{"p":"org.apache.datasketches.tuple.strings","l":"ArrayOfStringsSummaryFactory"},{"p":"org.apache.datasketches.tuple.strings","l":"ArrayOfStringsSummarySetOperations"},{"p":"org.apache.datasketches.common","l":"ArrayOfUtf16StringsSerDe"},{"p":"org.apache.datasketches.quantilescommon","l":"BinarySearch"},{"p":"org.apache.datasketches.tdigest","l":"BinarySearch"},{"p":"org.apache.datasketches.thetacommon","l":"BinomialBoundsN"},{"p":"org.apache.datasketches.theta","l":"BitPacking"},{"p":"org.apache.datasketches.filters.bloomfilter","l":"BloomFilter"},{"p":"org.apache.datasketches.filters.bloomfilter","l":"BloomFilterBuilder"},{"p":"org.apache.datasketches.common","l":"BoundsOnBinomialProportions"},{"p":"org.apache.datasketches.common","l":"BoundsOnRatiosInSampledSets"},{"p":"org.apache.datasketches.thetacommon","l":"BoundsOnRatiosInThetaSketchedSets"},{"p":"org.apache.datasketches.thetacommon","l":"BoundsOnRatiosInTupleSketchedSets"},{"p":"org.apache.datasketches.partitions","l":"BoundsRule"},{"p":"org.apache.datasketches.common","l":"ByteArrayUtil"},{"p":"org.apache.datasketches.quantiles","l":"ClassicUtil"},{"p":"org.apache.datasketches.quantiles","l":"CompactDoublesSketch"},{"p":"org.apache.datasketches.theta","l":"CompactSketch"},{"p":"org.apache.datasketches.tuple","l":"CompactSketch"},{"p":"org.apache.datasketches.cpc","l":"CompressionCharacterization"},{"p":"org.apache.datasketches.thetacommon","l":"SetOperationCornerCases.CornerCase"},{"p":"org.apache.datasketches.cpc","l":"CpcSketch"},{"p":"org.apache.datasketches.cpc","l":"CpcUnion"},{"p":"org.apache.datasketches.cpc","l":"CpcWrapper"},{"p":"org.apache.datasketches.tuple","l":"DeserializeResult"},{"p":"org.apache.datasketches.filters.bloomfilter","l":"DirectBitArrayR"},{"p":"org.apache.datasketches.tuple.adouble","l":"DoubleSketch"},{"p":"org.apache.datasketches.quantilescommon","l":"IncludeMinMax.DoublesPair"},{"p":"org.apache.datasketches.quantiles","l":"DoublesSketch"},{"p":"org.apache.datasketches.quantiles","l":"DoublesSketchBuilder"},{"p":"org.apache.datasketches.quantiles","l":"DoublesSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"DoublesSketchSortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"DoublesSortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"DoublesSortedViewIterator"},{"p":"org.apache.datasketches.tuple.adouble","l":"DoubleSummary"},{"p":"org.apache.datasketches.tuple.adouble","l":"DoubleSummaryDeserializer"},{"p":"org.apache.datasketches.tuple.adouble","l":"DoubleSummaryFactory"},{"p":"org.apache.datasketches.tuple.adouble","l":"DoubleSummarySetOperations"},{"p":"org.apache.datasketches.quantiles","l":"DoublesUnion"},{"p":"org.apache.datasketches.quantiles","l":"DoublesUnionBuilder"},{"p":"org.apache.datasketches.sampling","l":"EbppsItemsSketch"},{"p":"org.apache.datasketches.frequencies","l":"ErrorType"},{"p":"org.apache.datasketches.common","l":"Family"},{"p":"org.apache.datasketches.fdt","l":"FdtSketch"},{"p":"org.apache.datasketches.tuple","l":"Filter"},{"p":"org.apache.datasketches.quantilescommon","l":"IncludeMinMax.FloatsPair"},{"p":"org.apache.datasketches.quantilescommon","l":"FloatsSketchSortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"FloatsSortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"FloatsSortedViewIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"GenericInequalitySearch"},{"p":"org.apache.datasketches.quantilescommon","l":"GenericPartitionBoundaries"},{"p":"org.apache.datasketches.quantilescommon","l":"GenericSortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"GenericSortedViewIterator"},{"p":"org.apache.datasketches.fdt","l":"Group"},{"p":"org.apache.datasketches.theta","l":"HashIterator"},{"p":"org.apache.datasketches.thetacommon","l":"HashOperations"},{"p":"org.apache.datasketches.hll","l":"HllSketch"},{"p":"org.apache.datasketches.quantilescommon","l":"IncludeMinMax"},{"p":"org.apache.datasketches.quantilescommon","l":"GenericInequalitySearch.Inequality"},{"p":"org.apache.datasketches.quantilescommon","l":"InequalitySearch"},{"p":"org.apache.datasketches.tuple.aninteger","l":"IntegerSketch"},{"p":"org.apache.datasketches.tuple.aninteger","l":"IntegerSummary"},{"p":"org.apache.datasketches.tuple.aninteger","l":"IntegerSummaryDeserializer"},{"p":"org.apache.datasketches.tuple.aninteger","l":"IntegerSummaryFactory"},{"p":"org.apache.datasketches.tuple.aninteger","l":"IntegerSummarySetOperations"},{"p":"org.apache.datasketches.thetacommon","l":"SetOperationCornerCases.IntersectAction"},{"p":"org.apache.datasketches.theta","l":"Intersection"},{"p":"org.apache.datasketches.tuple","l":"Intersection"},{"p":"org.apache.datasketches.quantilescommon","l":"IncludeMinMax.ItemsPair"},{"p":"org.apache.datasketches.frequencies","l":"ItemsSketch"},{"p":"org.apache.datasketches.quantiles","l":"ItemsSketch"},{"p":"org.apache.datasketches.quantiles","l":"ItemsSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"ItemsSketchSortedView"},{"p":"org.apache.datasketches.quantiles","l":"ItemsUnion"},{"p":"org.apache.datasketches.theta","l":"JaccardSimilarity"},{"p":"org.apache.datasketches.tuple","l":"JaccardSimilarity"},{"p":"org.apache.datasketches.kll","l":"KllDoublesSketch"},{"p":"org.apache.datasketches.kll","l":"KllDoublesSketchIterator"},{"p":"org.apache.datasketches.kll","l":"KllFloatsSketch"},{"p":"org.apache.datasketches.kll","l":"KllFloatsSketchIterator"},{"p":"org.apache.datasketches.kll","l":"KllItemsSketch"},{"p":"org.apache.datasketches.kll","l":"KllItemsSketchIterator"},{"p":"org.apache.datasketches.kll","l":"KllLongsSketch"},{"p":"org.apache.datasketches.kll","l":"KllLongsSketchIterator"},{"p":"org.apache.datasketches.kll","l":"KllSketch"},{"p":"org.apache.datasketches.kll","l":"KllSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"KolmogorovSmirnov"},{"p":"org.apache.datasketches.quantilescommon","l":"IncludeMinMax.LongsPair"},{"p":"org.apache.datasketches.frequencies","l":"LongsSketch"},{"p":"org.apache.datasketches.quantilescommon","l":"LongsSketchSortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"LongsSortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"LongsSortedViewIterator"},{"p":"org.apache.datasketches.common","l":"MemoryStatus"},{"p":"org.apache.datasketches.cpc","l":"MergingValidation"},{"p":"org.apache.datasketches.tuple.adouble","l":"DoubleSummary.Mode"},{"p":"org.apache.datasketches.tuple.aninteger","l":"IntegerSummary.Mode"},{"p":"org.apache.datasketches.hash","l":"MurmurHash3"},{"p":"org.apache.datasketches.hash","l":"MurmurHash3Adaptor"},{"p":"org.apache.datasketches.partitions","l":"Partitioner.PartitionBoundsRow"},{"p":"org.apache.datasketches.partitions","l":"Partitioner"},{"p":"org.apache.datasketches.quantilescommon","l":"PartitioningFeature"},{"p":"org.apache.datasketches.fdt","l":"PostProcessor"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesAPI"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesDoublesAPI"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesDoublesSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantileSearchCriteria"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesFloatsAPI"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesFloatsSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesGenericAPI"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesGenericSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesLongsAPI"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesLongsSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesSketchIterator"},{"p":"org.apache.datasketches.quantilescommon","l":"QuantilesUtil"},{"p":"org.apache.datasketches.cpc","l":"QuickMergingValidation"},{"p":"org.apache.datasketches.thetacommon","l":"QuickSelect"},{"p":"org.apache.datasketches.req","l":"ReqDebug"},{"p":"org.apache.datasketches.req","l":"ReqSketch"},{"p":"org.apache.datasketches.req","l":"ReqSketchBuilder"},{"p":"org.apache.datasketches.req","l":"ReqSketchIterator"},{"p":"org.apache.datasketches.sampling","l":"ReservoirItemsSketch"},{"p":"org.apache.datasketches.sampling","l":"ReservoirItemsUnion"},{"p":"org.apache.datasketches.sampling","l":"ReservoirLongsSketch"},{"p":"org.apache.datasketches.sampling","l":"ReservoirLongsUnion"},{"p":"org.apache.datasketches.common","l":"ResizeFactor"},{"p":"org.apache.datasketches.frequencies","l":"ItemsSketch.Row"},{"p":"org.apache.datasketches.frequencies","l":"LongsSketch.Row"},{"p":"org.apache.datasketches.sampling","l":"SampleSubsetSummary"},{"p":"org.apache.datasketches.tuple","l":"SerializerDeserializer"},{"p":"org.apache.datasketches.theta","l":"SetOperation"},{"p":"org.apache.datasketches.theta","l":"SetOperationBuilder"},{"p":"org.apache.datasketches.thetacommon","l":"SetOperationCornerCases"},{"p":"org.apache.datasketches.theta","l":"Sketch"},{"p":"org.apache.datasketches.tuple","l":"Sketch"},{"p":"org.apache.datasketches.theta","l":"Sketches"},{"p":"org.apache.datasketches.tuple","l":"Sketches"},{"p":"org.apache.datasketches.common","l":"SketchesArgumentException"},{"p":"org.apache.datasketches.common","l":"SketchesException"},{"p":"org.apache.datasketches.common","l":"SketchesReadOnlyException"},{"p":"org.apache.datasketches.common","l":"SketchesStateException"},{"p":"org.apache.datasketches.partitions","l":"SketchFillRequest"},{"p":"org.apache.datasketches.quantilescommon","l":"SketchPartitionLimits"},{"p":"org.apache.datasketches.kll","l":"KllSketch.SketchStructure"},{"p":"org.apache.datasketches.kll","l":"KllSketch.SketchType"},{"p":"org.apache.datasketches.tuple","l":"SerializerDeserializer.SketchType"},{"p":"org.apache.datasketches.tdigest","l":"Sort"},{"p":"org.apache.datasketches.quantilescommon","l":"SortedView"},{"p":"org.apache.datasketches.quantilescommon","l":"SortedViewIterator"},{"p":"org.apache.datasketches.partitions","l":"Partitioner.StackElement"},{"p":"org.apache.datasketches.cpc","l":"StreamingValidation"},{"p":"org.apache.datasketches.tuple","l":"Summary"},{"p":"org.apache.datasketches.tuple","l":"SummaryDeserializer"},{"p":"org.apache.datasketches.tuple","l":"SummaryFactory"},{"p":"org.apache.datasketches.tuple","l":"SummarySetOperations"},{"p":"org.apache.datasketches.common","l":"SuppressFBWarnings"},{"p":"org.apache.datasketches.tdigest","l":"TDigestDouble"},{"p":"org.apache.datasketches.cpc","l":"TestUtil"},{"p":"org.apache.datasketches.hll","l":"TgtHllType"},{"p":"org.apache.datasketches.thetacommon","l":"ThetaUtil"},{"p":"org.apache.datasketches.tuple","l":"TupleSketchIterator"},{"p":"org.apache.datasketches.hll","l":"Union"},{"p":"org.apache.datasketches.theta","l":"Union"},{"p":"org.apache.datasketches.tuple","l":"Union"},{"p":"org.apache.datasketches.thetacommon","l":"SetOperationCornerCases.UnionAction"},{"p":"org.apache.datasketches.hllmap","l":"UniqueCountMap"},{"p":"org.apache.datasketches.tuple","l":"UpdatableSketch"},{"p":"org.apache.datasketches.tuple","l":"UpdatableSketchBuilder"},{"p":"org.apache.datasketches.tuple","l":"UpdatableSummary"},{"p":"org.apache.datasketches.quantiles","l":"UpdateDoublesSketch"},{"p":"org.apache.datasketches.theta","l":"UpdateReturnState"},{"p":"org.apache.datasketches.theta","l":"UpdateSketch"},{"p":"org.apache.datasketches.theta","l":"UpdateSketchBuilder"},{"p":"org.apache.datasketches.common","l":"Util"},{"p":"org.apache.datasketches.tuple","l":"Util"},{"p":"org.apache.datasketches.sampling","l":"VarOptItemsSamples.VarOptItemsIterator"},{"p":"org.apache.datasketches.sampling","l":"VarOptItemsSamples"},{"p":"org.apache.datasketches.sampling","l":"VarOptItemsSketch"},{"p":"org.apache.datasketches.sampling","l":"VarOptItemsUnion"},{"p":"org.apache.datasketches.sampling","l":"VarOptItemsSamples.WeightedSample"},{"p":"org.apache.datasketches.hash","l":"XxHash"}];updateSearchResults(); \ No newline at end of file